From f08ef1ac287123fe3559b0bebfe979f2756de3c1 Mon Sep 17 00:00:00 2001 From: github-actions Date: Mon, 22 Jan 2024 00:05:16 +0000 Subject: [PATCH] chore: self mutation Signed-off-by: github-actions --- docs/assets/main.js | 7 +- docs/assets/navigation.js | 1 + docs/assets/search.js | 2 +- docs/assets/style.css | 875 +++++++++++++--------- docs/classes/BillingStage.html | 293 +------- docs/classes/BudgetStack.html | 721 +++--------------- docs/classes/ControlTowerPipeline.html | 801 +++----------------- docs/classes/CostReportingStack.html | 711 +++--------------- docs/classes/LogArchiveStage.html | 283 +------ docs/classes/LogBucketStack.html | 717 +++--------------- docs/classes/SsoPermissionStack.html | 736 +++--------------- docs/classes/SsoStage.html | 297 +------- docs/functions/generateAccountFile.html | 85 +-- docs/functions/generateSsoConfigFile.html | 85 +-- docs/hierarchy.html | 1 + docs/index.html | 134 +--- docs/interfaces/AccountBudgetOptions.html | 72 +- docs/interfaces/AccountInfo.html | 102 +-- docs/interfaces/BillingStageConfig.html | 77 +- docs/interfaces/BudgetConfig.html | 71 +- docs/interfaces/ControlTowerProps.html | 83 +- docs/interfaces/CostReportingConfig.html | 84 +-- docs/interfaces/GroupInfo.html | 84 +-- docs/interfaces/LogArchiveConfig.html | 66 +- docs/interfaces/OrgPrincipalAware.html | 69 +- docs/interfaces/PermissionSetOptions.html | 120 +-- docs/interfaces/SsoConfig.html | 83 +- docs/interfaces/SsoPermissionConfig.html | 132 +--- docs/interfaces/SsoProps.html | 98 +-- docs/interfaces/SsoStageConfig.html | 73 +- docs/modules.html | 164 +--- docs/types/AccountConfig.html | 88 +-- docs/types/AccountList.html | 86 +-- docs/types/BillingStageProps.html | 86 +-- docs/types/BudgetStackProps.html | 86 +-- docs/types/ControlTowerPipelineProps.html | 88 +-- docs/types/CostReportingStackProps.html | 81 +- docs/types/GroupConfig.html | 88 +-- docs/types/GroupList.html | 86 +-- docs/types/LogArchiveStageProps.html | 81 +- docs/types/LogBucketStackProps.html | 81 +- docs/types/SsoPermissionStackProps.html | 88 +-- docs/types/SsoStageProps.html | 88 +-- 43 files changed, 1253 insertions(+), 6901 deletions(-) create mode 100644 docs/assets/navigation.js create mode 100644 docs/hierarchy.html diff --git a/docs/assets/main.js b/docs/assets/main.js index f7c8366..7270cff 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,7 +1,8 @@ "use strict"; -"use strict";(()=>{var Qe=Object.create;var ae=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Ce=Object.getOwnPropertyNames;var Oe=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var _e=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Me=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ce(e))!Re.call(t,i)&&i!==n&&ae(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Qe(Oe(t)):{},Me(e||!t||!t.__esModule?ae(n,"default",{value:t,enumerable:!0}):n,t));var de=_e((ce,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 h=t.utils.clone(n)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(r.slice(a,o),h))}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(ou?h+=2:a==u&&(n+=r[l+1]*i[h+1],l+=2,h+=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 u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}if(s.str.length==0&&(u.final=!0),i.push({node:u,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 h=s.str.charAt(0),m=s.str.charAt(1),v;m in s.node.edges?v=s.node.edges[m]:(v=new t.TokenSet,s.node.edges[m]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+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),u=0;u1?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 ce=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});var le=[];function B(t,e){le.push({selector:e,constructor:t})}var Y=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){le.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()}ensureFocusedElementVisible(){this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null);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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}};var I=class{constructor(e){this.el=e.el,this.app=e.app}};var J=class{constructor(){this.listeners={}}addEventListener(e,n){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(n)}removeEventListener(e,n){if(!(e in this.listeners))return;let r=this.listeners[e];for(let i=0,s=r.length;i{let n=Date.now();return(...r)=>{n+e-Date.now()<0&&(t(...r),n=Date.now())}};var re=class extends J{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.navigation=document.querySelector(".col-menu"),window.addEventListener("scroll",ne(()=>this.onScroll(),10)),window.addEventListener("resize",ne(()=>this.onResize(),10)),this.searchInput=document.querySelector("#tsd-search input"),this.searchInput&&this.searchInput.addEventListener("focus",()=>{this.hideShowToolbar()}),this.onResize(),this.onScroll()}triggerResize(){let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let n=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(n)}onScroll(){this.scrollTop=window.scrollY||0;let n=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(n),this.hideShowToolbar()}hideShowToolbar(){let n=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0||!!this.searchInput&&this.searchInput===document.activeElement,n!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.navigation?.classList.toggle("col-menu--hide")),this.lastY=this.scrollTop}},R=re;R.instance=new re;var X=class extends I{constructor(n){super(n);this.anchors=[];this.index=-1;R.instance.addEventListener("resize",()=>this.onResize()),R.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substring(0,n.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let i=r.href;if(i.indexOf("#")==-1||i.substring(0,n.length)!=n)return;let s=i.substring(i.indexOf("#")+1),o=document.querySelector("a.tsd-anchor[name="+s+"]"),a=r.parentNode;!o||!a||this.anchors.push({link:a,anchor:o,position:0})}),this.onResize()}onResize(){let n;for(let i=0,s=this.anchors.length;ii.position-s.position);let r=new CustomEvent("scroll",{detail:{scrollTop:R.instance.scrollTop}});this.onScroll(r)}onScroll(n){let r=n.detail.scrollTop+5,i=this.anchors,s=i.length-1,o=this.index;for(;o>-1&&i[o].position>r;)o-=1;for(;o-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=o,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var me=De(de());function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("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 n=document.querySelector("#tsd-search input"),r=document.querySelector("#tsd-search .results");if(!n||!r)throw new Error("The input field or the result list wrapper was not found");let i=!1;r.addEventListener("mousedown",()=>i=!0),r.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),n.addEventListener("focus",()=>t.classList.add("has-focus")),n.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Fe(t,r,n,s)}function Fe(t,e,n,r){n.addEventListener("input",ue(()=>{He(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?pe(e,-1):s.key==="ArrowDown"?pe(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ae(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=me.Index.load(window.searchData.index))}function He(t,e,n,r){if(Ae(r,t),!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s=i?r.index.search(`*${i}*`):[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o${fe(u.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=u.classes??"";let m=document.createElement("a");m.href=r.base+u.url,m.innerHTML=l,h.append(m),e.appendChild(h)}}function pe(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(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),e.blur()}}function fe(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(ie(t.substring(s,o)),`${ie(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ie(t.substring(s))),i.join("")}var Ne={"&":"&","<":"<",">":">","'":"'",'"':"""};function ie(t){return t.replace(/[&<>"'"]/g,e=>Ne[e])}var F="mousedown",ye="mousemove",j="mouseup",Z={x:0,y:0},ge=!1,se=!1,Be=!1,A=!1,xe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(xe?"is-mobile":"not-mobile");xe&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",ye="touchmove",j="touchend");document.addEventListener(F,t=>{se=!0,A=!1;let e=F=="touchstart"?t.targetTouches[0]:t;Z.y=e.pageY||0,Z.x=e.pageX||0});document.addEventListener(ye,t=>{if(se&&!A){let e=F=="touchstart"?t.targetTouches[0]:t,n=Z.x-(e.pageX||0),r=Z.y-(e.pageY||0);A=Math.sqrt(n*n+r*r)>10}});document.addEventListener(j,()=>{se=!1});document.addEventListener("click",t=>{ge&&(t.preventDefault(),t.stopImmediatePropagation(),ge=!1)});var K=class extends I{constructor(n){super(n);this.className=this.el.dataset.toggle||"",this.el.addEventListener(j,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(F,r=>this.onDocumentPointerDown(r)),document.addEventListener(j,r=>this.onDocumentPointerUp(r))}setActive(n){if(this.active==n)return;this.active=n,document.documentElement.classList.toggle("has-"+this.className,n),this.el.classList.toggle("active",n);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(n){A||(this.setActive(!0),n.preventDefault())}onDocumentPointerDown(n){if(this.active){if(n.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(n){if(!A&&this.active&&n.target.closest(".col-menu")){let r=n.target.closest("a");if(r){let i=window.location.href;i.indexOf("#")!=-1&&(i=i.substring(0,i.indexOf("#"))),r.href.substring(0,i.length)==i&&setTimeout(()=>this.setActive(!1),250)}}}};var oe;try{oe=localStorage}catch{oe={getItem(){return null},setItem(){}}}var Q=oe;var Le=document.head.appendChild(document.createElement("style"));Le.dataset.for="filters";var ee=class extends I{constructor(n){super(n);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; } -`}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.checked}setLocalStorage(n){Q.setItem(this.key,n.toString()),this.value=n,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(n=>{n.style.display="block";let r=Array.from(n.querySelectorAll(".tsd-index-link")).every(i=>i.offsetParent==null);n.style.display=r?"none":"block"})}};var te=class extends I{constructor(n){super(n);this.calculateHeights(),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.textContent.replace(/\s+/g,"-").toLowerCase()}`,this.setLocalStorage(this.fromLocalStorage(),!0),this.summary.addEventListener("click",r=>this.toggleVisibility(r)),this.icon.style.transform=this.getIconRotation()}getIconRotation(n=this.el.open){return`rotate(${n?0:-90}deg)`}calculateHeights(){let n=this.el.open,{position:r,left:i}=this.el.style;this.el.style.position="fixed",this.el.style.left="-9999px",this.el.open=!0,this.expandedHeight=this.el.offsetHeight+"px",this.el.open=!1,this.collapsedHeight=this.el.offsetHeight+"px",this.el.open=n,this.el.style.height=n?this.expandedHeight:this.collapsedHeight,this.el.style.position=r,this.el.style.left=i}toggleVisibility(n){n.preventDefault(),this.el.style.overflow="hidden",this.el.open?this.collapse():this.expand()}expand(n=!0){this.el.open=!0,this.animate(this.collapsedHeight,this.expandedHeight,{opening:!0,duration:n?300:0})}collapse(n=!0){this.animate(this.expandedHeight,this.collapsedHeight,{opening:!1,duration:n?300:0})}animate(n,r,{opening:i,duration:s=300}){if(this.animation)return;let o={duration:s,easing:"ease"};this.animation=this.el.animate({height:[n,r]},o),this.icon.animate({transform:[this.icon.style.transform||this.getIconRotation(!i),this.getIconRotation(i)]},o).addEventListener("finish",()=>{this.icon.style.transform=this.getIconRotation(i)}),this.animation.addEventListener("finish",()=>this.animationEnd(i))}animationEnd(n){this.el.open=n,this.animation=void 0,this.el.style.height="auto",this.el.style.overflow="visible",this.setLocalStorage(n)}fromLocalStorage(){let n=Q.getItem(this.key);return n?n==="true":this.el.open}setLocalStorage(n,r=!1){this.fromLocalStorage()===n&&!r||(Q.setItem(this.key,n.toString()),this.el.open=n,this.handleValueChange(r))}handleValueChange(n=!1){this.fromLocalStorage()===this.el.open&&!n||(this.fromLocalStorage()?this.expand(!1):this.collapse(!1))}};function be(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,Ee(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),Ee(t.value)})}function Ee(t){document.documentElement.dataset.theme=t}ve();B(X,".menu-highlight");B(K,"a[data-toggle]");B(te,".tsd-index-accordion");B(ee,".tsd-filter-item input[type=checkbox]");var we=document.getElementById("theme");we&&be(we);var je=new Y;Object.defineProperty(window,"app",{value:je});})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(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,u],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[u+1]*i[d+1],u+=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 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),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,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 se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.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){re.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()}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){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}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&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}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="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.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",()=>{le(e,t)}),le(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");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(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=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(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),e.blur()}}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(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!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&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{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(F,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 te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{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()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.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(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),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());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(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}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(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-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(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 u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js new file mode 100644 index 0000000..f52f90f --- /dev/null +++ b/docs/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43VXU/CMBQG4P/SayJCBJU7INGYkECcd8aLpXSjobRL24nG+N8NIFvXnp7u+rx71u/z/kMs+7JkRhZcCC7LzOYlIwNS5XZHZoSK3Bhmhm71ZmcPggzInsstmY3GD7+DVqm3JbOZzekeQNoiZiyVtFqJN3VkesMrJrgERgSlcNXYV1YpbS/zgAYYZjBxpcq5pjv+ySKL5gUS1qKm++jSdeuYlBm1YfrAjeFKRrQwkxAjE7xWsK/nlKpa2sveryvLlTStxKVlusgpM0Mo2IXHk2kIv8hCYd6pjjHuyV4qWfAS1MIYip4ngXFOAIM6p1yrCl66IIWTziFHhgjkMPZZq7qKbkZTxYj2viDD8kMYuNblRnNJeZWL+THXDBSDFEY69wY/zlAQgzOjkFk31QTR/hXH/FyKjR69azEBpK5XN9Lj2vuW/a7aOw8qt4/3o8k4lFbc2IhzKqUU92HwluliBYGk2LZJGPTqKQ/qlCAcDab/4PfNiA/GUvr57YD32yn1UqC9bgopwWvn4BShTA/X6e0x1o+k1LDHg3Ik1kOPL0KnmJJKJpnOLfu/ck9cOK90UUt6fjmHQKwrT+8AtHk2U2wnGMAff3s4XAwnCwAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 668f05f..23c8ad2 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = JSON.parse("{\"kinds\":{\"64\":\"Function\",\"128\":\"Class\",\"256\":\"Interface\",\"512\":\"Constructor\",\"1024\":\"Property\",\"2048\":\"Method\",\"65536\":\"Type literal\",\"4194304\":\"Type alias\"},\"rows\":[{\"kind\":64,\"name\":\"generateAccountFile\",\"url\":\"functions/generateAccountFile.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":64,\"name\":\"generateSsoConfigFile\",\"url\":\"functions/generateSsoConfigFile.html\",\"classes\":\"tsd-kind-function\"},{\"kind\":256,\"name\":\"AccountInfo\",\"url\":\"interfaces/AccountInfo.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"Id\",\"url\":\"interfaces/AccountInfo.html#Id\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Name\",\"url\":\"interfaces/AccountInfo.html#Name\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Email\",\"url\":\"interfaces/AccountInfo.html#Email\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Arn\",\"url\":\"interfaces/AccountInfo.html#Arn\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedMethod\",\"url\":\"interfaces/AccountInfo.html#JoinedMethod\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"JoinedTimestamp\",\"url\":\"interfaces/AccountInfo.html#JoinedTimestamp\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":1024,\"name\":\"Status\",\"url\":\"interfaces/AccountInfo.html#Status\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountInfo\"},{\"kind\":4194304,\"name\":\"AccountList\",\"url\":\"types/AccountList.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"AccountConfig\",\"url\":\"types/AccountConfig.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":4194304,\"name\":\"GroupConfig\",\"url\":\"types/GroupConfig.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"GroupInfo\",\"url\":\"interfaces/GroupInfo.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"GroupId\",\"url\":\"interfaces/GroupInfo.html#GroupId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"DisplayName\",\"url\":\"interfaces/GroupInfo.html#DisplayName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"ExternalIds\",\"url\":\"interfaces/GroupInfo.html#ExternalIds\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":1024,\"name\":\"Description\",\"url\":\"interfaces/GroupInfo.html#Description\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"GroupInfo\"},{\"kind\":4194304,\"name\":\"GroupList\",\"url\":\"types/GroupList.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":256,\"name\":\"SsoConfig\",\"url\":\"interfaces/SsoConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"instanceArn\",\"url\":\"interfaces/SsoConfig.html#instanceArn\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"identityStoreId\",\"url\":\"interfaces/SsoConfig.html#identityStoreId\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":1024,\"name\":\"groups\",\"url\":\"interfaces/SsoConfig.html#groups\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoConfig\"},{\"kind\":256,\"name\":\"OrgPrincipalAware\",\"url\":\"interfaces/OrgPrincipalAware.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"orgPrincipalEnv\",\"url\":\"interfaces/OrgPrincipalAware.html#orgPrincipalEnv\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"OrgPrincipalAware\"},{\"kind\":256,\"name\":\"ControlTowerProps\",\"url\":\"interfaces/ControlTowerProps.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/ControlTowerProps.html#accounts\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"ControlTowerProps\"},{\"kind\":256,\"name\":\"SsoProps\",\"url\":\"interfaces/SsoProps.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"ssoConfig\",\"url\":\"interfaces/SsoProps.html#ssoConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoProps\"},{\"kind\":1024,\"name\":\"accounts\",\"url\":\"interfaces/SsoProps.html#accounts\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface tsd-is-inherited\",\"parent\":\"SsoProps\"},{\"kind\":4194304,\"name\":\"LogBucketStackProps\",\"url\":\"types/LogBucketStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"LogBucketStack\",\"url\":\"classes/LogBucketStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogBucketStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LogBucketStack\"},{\"kind\":1024,\"name\":\"flowLogsBucketName\",\"url\":\"classes/LogBucketStack.html#flowLogsBucketName\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"LogBucketStack\"},{\"kind\":256,\"name\":\"AccountBudgetOptions\",\"url\":\"interfaces/AccountBudgetOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"amount\",\"url\":\"interfaces/AccountBudgetOptions.html#amount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":1024,\"name\":\"email\",\"url\":\"interfaces/AccountBudgetOptions.html#email\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"AccountBudgetOptions\"},{\"kind\":256,\"name\":\"BudgetConfig\",\"url\":\"interfaces/BudgetConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"budgets\",\"url\":\"interfaces/BudgetConfig.html#budgets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BudgetConfig\"},{\"kind\":4194304,\"name\":\"BudgetStackProps\",\"url\":\"types/BudgetStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"BudgetStack\",\"url\":\"classes/BudgetStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BudgetStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"BudgetStack\"},{\"kind\":256,\"name\":\"CostReportingConfig\",\"url\":\"interfaces/CostReportingConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"costReportBucketName\",\"url\":\"interfaces/CostReportingConfig.html#costReportBucketName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CostReportingConfig\"},{\"kind\":1024,\"name\":\"costReportName\",\"url\":\"interfaces/CostReportingConfig.html#costReportName\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"CostReportingConfig\"},{\"kind\":4194304,\"name\":\"CostReportingStackProps\",\"url\":\"types/CostReportingStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"CostReportingStack\",\"url\":\"classes/CostReportingStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/CostReportingStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"CostReportingStack\"},{\"kind\":256,\"name\":\"PermissionSetOptions\",\"url\":\"interfaces/PermissionSetOptions.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"description\",\"url\":\"interfaces/PermissionSetOptions.html#description\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"inlinePolicy\",\"url\":\"interfaces/PermissionSetOptions.html#inlinePolicy\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"managedPolicies\",\"url\":\"interfaces/PermissionSetOptions.html#managedPolicies\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"sessionDuration\",\"url\":\"interfaces/PermissionSetOptions.html#sessionDuration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":1024,\"name\":\"relayStateType\",\"url\":\"interfaces/PermissionSetOptions.html#relayStateType\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"PermissionSetOptions\"},{\"kind\":256,\"name\":\"SsoPermissionConfig\",\"url\":\"interfaces/SsoPermissionConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"groupPermissions\",\"url\":\"interfaces/SsoPermissionConfig.html#groupPermissions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"adminSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#adminSetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"readOnlySetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#readOnlySetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"billingSetOptions\",\"url\":\"interfaces/SsoPermissionConfig.html#billingSetOptions\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"interfaces/SsoPermissionConfig.html#permissionSets.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"SsoPermissionConfig.permissionSets\"},{\"kind\":1024,\"name\":\"defaultAssignmentsForNewAccount\",\"url\":\"interfaces/SsoPermissionConfig.html#defaultAssignmentsForNewAccount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoPermissionConfig\"},{\"kind\":4194304,\"name\":\"SsoPermissionStackProps\",\"url\":\"types/SsoPermissionStackProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"SsoPermissionStack\",\"url\":\"classes/SsoPermissionStack.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoPermissionStack.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"SsoPermissionStack\"},{\"kind\":1024,\"name\":\"permissionSets\",\"url\":\"classes/SsoPermissionStack.html#permissionSets\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"SsoPermissionStack\"},{\"kind\":65536,\"name\":\"__type\",\"url\":\"classes/SsoPermissionStack.html#permissionSets.__type\",\"classes\":\"tsd-kind-type-literal tsd-parent-kind-property\",\"parent\":\"SsoPermissionStack.permissionSets\"},{\"kind\":256,\"name\":\"BillingStageConfig\",\"url\":\"interfaces/BillingStageConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"budgetConfig\",\"url\":\"interfaces/BillingStageConfig.html#budgetConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BillingStageConfig\"},{\"kind\":1024,\"name\":\"costReportConfig\",\"url\":\"interfaces/BillingStageConfig.html#costReportConfig\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"BillingStageConfig\"},{\"kind\":4194304,\"name\":\"BillingStageProps\",\"url\":\"types/BillingStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"BillingStage\",\"url\":\"classes/BillingStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/BillingStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"BillingStage\"},{\"kind\":256,\"name\":\"LogArchiveConfig\",\"url\":\"interfaces/LogArchiveConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"logArchiveAccount\",\"url\":\"interfaces/LogArchiveConfig.html#logArchiveAccount\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"LogArchiveConfig\"},{\"kind\":4194304,\"name\":\"LogArchiveStageProps\",\"url\":\"types/LogArchiveStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"LogArchiveStage\",\"url\":\"classes/LogArchiveStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/LogArchiveStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"LogArchiveStage\"},{\"kind\":4194304,\"name\":\"ControlTowerPipelineProps\",\"url\":\"types/ControlTowerPipelineProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"ControlTowerPipeline\",\"url\":\"classes/ControlTowerPipeline.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/ControlTowerPipeline.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"pipeline\",\"url\":\"classes/ControlTowerPipeline.html#pipeline\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"repository\",\"url\":\"classes/ControlTowerPipeline.html#repository\",\"classes\":\"tsd-kind-property tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":1024,\"name\":\"props\",\"url\":\"classes/ControlTowerPipeline.html#props\",\"classes\":\"tsd-kind-property tsd-parent-kind-class tsd-is-private\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addStage\",\"url\":\"classes/ControlTowerPipeline.html#addStage\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addSsoConfig\",\"url\":\"classes/ControlTowerPipeline.html#addSsoConfig\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addBillingConfig\",\"url\":\"classes/ControlTowerPipeline.html#addBillingConfig\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":2048,\"name\":\"addLogArchive\",\"url\":\"classes/ControlTowerPipeline.html#addLogArchive\",\"classes\":\"tsd-kind-method tsd-parent-kind-class\",\"parent\":\"ControlTowerPipeline\"},{\"kind\":256,\"name\":\"SsoStageConfig\",\"url\":\"interfaces/SsoStageConfig.html\",\"classes\":\"tsd-kind-interface\"},{\"kind\":1024,\"name\":\"permissionsConfiguration\",\"url\":\"interfaces/SsoStageConfig.html#permissionsConfiguration\",\"classes\":\"tsd-kind-property tsd-parent-kind-interface\",\"parent\":\"SsoStageConfig\"},{\"kind\":4194304,\"name\":\"SsoStageProps\",\"url\":\"types/SsoStageProps.html\",\"classes\":\"tsd-kind-type-alias\"},{\"kind\":128,\"name\":\"SsoStage\",\"url\":\"classes/SsoStage.html\",\"classes\":\"tsd-kind-class\"},{\"kind\":512,\"name\":\"constructor\",\"url\":\"classes/SsoStage.html#constructor\",\"classes\":\"tsd-kind-constructor tsd-parent-kind-class\",\"parent\":\"SsoStage\"}],\"index\":{\"version\":\"2.3.9\",\"fields\":[\"name\",\"comment\"],\"fieldVectors\":[[\"name/0\",[0,41.378]],[\"comment/0\",[]],[\"name/1\",[1,41.378]],[\"comment/1\",[]],[\"name/2\",[2,41.378]],[\"comment/2\",[]],[\"name/3\",[3,41.378]],[\"comment/3\",[]],[\"name/4\",[4,41.378]],[\"comment/4\",[]],[\"name/5\",[5,36.27]],[\"comment/5\",[]],[\"name/6\",[6,41.378]],[\"comment/6\",[]],[\"name/7\",[7,41.378]],[\"comment/7\",[]],[\"name/8\",[8,41.378]],[\"comment/8\",[]],[\"name/9\",[9,41.378]],[\"comment/9\",[]],[\"name/10\",[10,41.378]],[\"comment/10\",[]],[\"name/11\",[11,41.378]],[\"comment/11\",[]],[\"name/12\",[12,41.378]],[\"comment/12\",[]],[\"name/13\",[13,41.378]],[\"comment/13\",[]],[\"name/14\",[14,41.378]],[\"comment/14\",[]],[\"name/15\",[15,41.378]],[\"comment/15\",[]],[\"name/16\",[16,41.378]],[\"comment/16\",[]],[\"name/17\",[17,36.27]],[\"comment/17\",[]],[\"name/18\",[18,41.378]],[\"comment/18\",[]],[\"name/19\",[19,36.27]],[\"comment/19\",[]],[\"name/20\",[20,41.378]],[\"comment/20\",[]],[\"name/21\",[21,41.378]],[\"comment/21\",[]],[\"name/22\",[22,41.378]],[\"comment/22\",[]],[\"name/23\",[23,41.378]],[\"comment/23\",[]],[\"name/24\",[24,41.378]],[\"comment/24\",[]],[\"name/25\",[25,41.378]],[\"comment/25\",[]],[\"name/26\",[26,36.27]],[\"comment/26\",[]],[\"name/27\",[27,41.378]],[\"comment/27\",[]],[\"name/28\",[19,36.27]],[\"comment/28\",[]],[\"name/29\",[26,36.27]],[\"comment/29\",[]],[\"name/30\",[28,41.378]],[\"comment/30\",[]],[\"name/31\",[29,41.378]],[\"comment/31\",[]],[\"name/32\",[30,24.032]],[\"comment/32\",[]],[\"name/33\",[31,41.378]],[\"comment/33\",[]],[\"name/34\",[32,41.378]],[\"comment/34\",[]],[\"name/35\",[33,41.378]],[\"comment/35\",[]],[\"name/36\",[5,36.27]],[\"comment/36\",[]],[\"name/37\",[34,36.27]],[\"comment/37\",[]],[\"name/38\",[35,41.378]],[\"comment/38\",[]],[\"name/39\",[36,41.378]],[\"comment/39\",[]],[\"name/40\",[37,41.378]],[\"comment/40\",[]],[\"name/41\",[30,24.032]],[\"comment/41\",[]],[\"name/42\",[38,41.378]],[\"comment/42\",[]],[\"name/43\",[39,41.378]],[\"comment/43\",[]],[\"name/44\",[40,41.378]],[\"comment/44\",[]],[\"name/45\",[41,41.378]],[\"comment/45\",[]],[\"name/46\",[42,41.378]],[\"comment/46\",[]],[\"name/47\",[30,24.032]],[\"comment/47\",[]],[\"name/48\",[43,41.378]],[\"comment/48\",[]],[\"name/49\",[17,36.27]],[\"comment/49\",[]],[\"name/50\",[44,41.378]],[\"comment/50\",[]],[\"name/51\",[45,41.378]],[\"comment/51\",[]],[\"name/52\",[46,41.378]],[\"comment/52\",[]],[\"name/53\",[47,41.378]],[\"comment/53\",[]],[\"name/54\",[48,41.378]],[\"comment/54\",[]],[\"name/55\",[49,41.378]],[\"comment/55\",[]],[\"name/56\",[50,41.378]],[\"comment/56\",[]],[\"name/57\",[51,41.378]],[\"comment/57\",[]],[\"name/58\",[52,41.378]],[\"comment/58\",[]],[\"name/59\",[53,36.27]],[\"comment/59\",[]],[\"name/60\",[54,36.27]],[\"comment/60\",[]],[\"name/61\",[55,41.378]],[\"comment/61\",[]],[\"name/62\",[56,41.378]],[\"comment/62\",[]],[\"name/63\",[57,41.378]],[\"comment/63\",[]],[\"name/64\",[30,24.032]],[\"comment/64\",[]],[\"name/65\",[53,36.27]],[\"comment/65\",[]],[\"name/66\",[54,36.27]],[\"comment/66\",[]],[\"name/67\",[58,41.378]],[\"comment/67\",[]],[\"name/68\",[34,36.27]],[\"comment/68\",[]],[\"name/69\",[59,41.378]],[\"comment/69\",[]],[\"name/70\",[60,41.378]],[\"comment/70\",[]],[\"name/71\",[61,41.378]],[\"comment/71\",[]],[\"name/72\",[30,24.032]],[\"comment/72\",[]],[\"name/73\",[62,41.378]],[\"comment/73\",[]],[\"name/74\",[63,41.378]],[\"comment/74\",[]],[\"name/75\",[64,41.378]],[\"comment/75\",[]],[\"name/76\",[65,41.378]],[\"comment/76\",[]],[\"name/77\",[30,24.032]],[\"comment/77\",[]],[\"name/78\",[66,41.378]],[\"comment/78\",[]],[\"name/79\",[67,41.378]],[\"comment/79\",[]],[\"name/80\",[30,24.032]],[\"comment/80\",[]],[\"name/81\",[68,41.378]],[\"comment/81\",[]],[\"name/82\",[69,41.378]],[\"comment/82\",[]],[\"name/83\",[70,41.378]],[\"comment/83\",[]],[\"name/84\",[71,41.378]],[\"comment/84\",[]],[\"name/85\",[72,41.378]],[\"comment/85\",[]],[\"name/86\",[73,41.378]],[\"comment/86\",[]],[\"name/87\",[74,41.378]],[\"comment/87\",[]],[\"name/88\",[75,41.378]],[\"comment/88\",[]],[\"name/89\",[76,41.378]],[\"comment/89\",[]],[\"name/90\",[77,41.378]],[\"comment/90\",[]],[\"name/91\",[78,41.378]],[\"comment/91\",[]],[\"name/92\",[30,24.032]],[\"comment/92\",[]]],\"invertedIndex\":[[\"__type\",{\"_index\":54,\"name\":{\"60\":{},\"66\":{}},\"comment\":{}}],[\"accountbudgetoptions\",{\"_index\":32,\"name\":{\"34\":{}},\"comment\":{}}],[\"accountconfig\",{\"_index\":11,\"name\":{\"11\":{}},\"comment\":{}}],[\"accountinfo\",{\"_index\":2,\"name\":{\"2\":{}},\"comment\":{}}],[\"accountlist\",{\"_index\":10,\"name\":{\"10\":{}},\"comment\":{}}],[\"accounts\",{\"_index\":26,\"name\":{\"26\":{},\"29\":{}},\"comment\":{}}],[\"addbillingconfig\",{\"_index\":73,\"name\":{\"86\":{}},\"comment\":{}}],[\"addlogarchive\",{\"_index\":74,\"name\":{\"87\":{}},\"comment\":{}}],[\"addssoconfig\",{\"_index\":72,\"name\":{\"85\":{}},\"comment\":{}}],[\"addstage\",{\"_index\":71,\"name\":{\"84\":{}},\"comment\":{}}],[\"adminsetoptions\",{\"_index\":50,\"name\":{\"56\":{}},\"comment\":{}}],[\"amount\",{\"_index\":33,\"name\":{\"35\":{}},\"comment\":{}}],[\"arn\",{\"_index\":6,\"name\":{\"6\":{}},\"comment\":{}}],[\"billingsetoptions\",{\"_index\":52,\"name\":{\"58\":{}},\"comment\":{}}],[\"billingstage\",{\"_index\":61,\"name\":{\"71\":{}},\"comment\":{}}],[\"billingstageconfig\",{\"_index\":58,\"name\":{\"67\":{}},\"comment\":{}}],[\"billingstageprops\",{\"_index\":60,\"name\":{\"70\":{}},\"comment\":{}}],[\"budgetconfig\",{\"_index\":34,\"name\":{\"37\":{},\"68\":{}},\"comment\":{}}],[\"budgets\",{\"_index\":35,\"name\":{\"38\":{}},\"comment\":{}}],[\"budgetstack\",{\"_index\":37,\"name\":{\"40\":{}},\"comment\":{}}],[\"budgetstackprops\",{\"_index\":36,\"name\":{\"39\":{}},\"comment\":{}}],[\"constructor\",{\"_index\":30,\"name\":{\"32\":{},\"41\":{},\"47\":{},\"64\":{},\"72\":{},\"77\":{},\"80\":{},\"92\":{}},\"comment\":{}}],[\"controltowerpipeline\",{\"_index\":67,\"name\":{\"79\":{}},\"comment\":{}}],[\"controltowerpipelineprops\",{\"_index\":66,\"name\":{\"78\":{}},\"comment\":{}}],[\"controltowerprops\",{\"_index\":25,\"name\":{\"25\":{}},\"comment\":{}}],[\"costreportbucketname\",{\"_index\":39,\"name\":{\"43\":{}},\"comment\":{}}],[\"costreportconfig\",{\"_index\":59,\"name\":{\"69\":{}},\"comment\":{}}],[\"costreportingconfig\",{\"_index\":38,\"name\":{\"42\":{}},\"comment\":{}}],[\"costreportingstack\",{\"_index\":42,\"name\":{\"46\":{}},\"comment\":{}}],[\"costreportingstackprops\",{\"_index\":41,\"name\":{\"45\":{}},\"comment\":{}}],[\"costreportname\",{\"_index\":40,\"name\":{\"44\":{}},\"comment\":{}}],[\"defaultassignmentsfornewaccount\",{\"_index\":55,\"name\":{\"61\":{}},\"comment\":{}}],[\"description\",{\"_index\":17,\"name\":{\"17\":{},\"49\":{}},\"comment\":{}}],[\"displayname\",{\"_index\":15,\"name\":{\"15\":{}},\"comment\":{}}],[\"email\",{\"_index\":5,\"name\":{\"5\":{},\"36\":{}},\"comment\":{}}],[\"externalids\",{\"_index\":16,\"name\":{\"16\":{}},\"comment\":{}}],[\"flowlogsbucketname\",{\"_index\":31,\"name\":{\"33\":{}},\"comment\":{}}],[\"generateaccountfile\",{\"_index\":0,\"name\":{\"0\":{}},\"comment\":{}}],[\"generatessoconfigfile\",{\"_index\":1,\"name\":{\"1\":{}},\"comment\":{}}],[\"groupconfig\",{\"_index\":12,\"name\":{\"12\":{}},\"comment\":{}}],[\"groupid\",{\"_index\":14,\"name\":{\"14\":{}},\"comment\":{}}],[\"groupinfo\",{\"_index\":13,\"name\":{\"13\":{}},\"comment\":{}}],[\"grouplist\",{\"_index\":18,\"name\":{\"18\":{}},\"comment\":{}}],[\"grouppermissions\",{\"_index\":49,\"name\":{\"55\":{}},\"comment\":{}}],[\"groups\",{\"_index\":22,\"name\":{\"22\":{}},\"comment\":{}}],[\"id\",{\"_index\":3,\"name\":{\"3\":{}},\"comment\":{}}],[\"identitystoreid\",{\"_index\":21,\"name\":{\"21\":{}},\"comment\":{}}],[\"inlinepolicy\",{\"_index\":44,\"name\":{\"50\":{}},\"comment\":{}}],[\"instancearn\",{\"_index\":20,\"name\":{\"20\":{}},\"comment\":{}}],[\"joinedmethod\",{\"_index\":7,\"name\":{\"7\":{}},\"comment\":{}}],[\"joinedtimestamp\",{\"_index\":8,\"name\":{\"8\":{}},\"comment\":{}}],[\"logarchiveaccount\",{\"_index\":63,\"name\":{\"74\":{}},\"comment\":{}}],[\"logarchiveconfig\",{\"_index\":62,\"name\":{\"73\":{}},\"comment\":{}}],[\"logarchivestage\",{\"_index\":65,\"name\":{\"76\":{}},\"comment\":{}}],[\"logarchivestageprops\",{\"_index\":64,\"name\":{\"75\":{}},\"comment\":{}}],[\"logbucketstack\",{\"_index\":29,\"name\":{\"31\":{}},\"comment\":{}}],[\"logbucketstackprops\",{\"_index\":28,\"name\":{\"30\":{}},\"comment\":{}}],[\"managedpolicies\",{\"_index\":45,\"name\":{\"51\":{}},\"comment\":{}}],[\"name\",{\"_index\":4,\"name\":{\"4\":{}},\"comment\":{}}],[\"orgprincipalaware\",{\"_index\":23,\"name\":{\"23\":{}},\"comment\":{}}],[\"orgprincipalenv\",{\"_index\":24,\"name\":{\"24\":{}},\"comment\":{}}],[\"permissionsconfiguration\",{\"_index\":76,\"name\":{\"89\":{}},\"comment\":{}}],[\"permissionsetoptions\",{\"_index\":43,\"name\":{\"48\":{}},\"comment\":{}}],[\"permissionsets\",{\"_index\":53,\"name\":{\"59\":{},\"65\":{}},\"comment\":{}}],[\"pipeline\",{\"_index\":68,\"name\":{\"81\":{}},\"comment\":{}}],[\"props\",{\"_index\":70,\"name\":{\"83\":{}},\"comment\":{}}],[\"readonlysetoptions\",{\"_index\":51,\"name\":{\"57\":{}},\"comment\":{}}],[\"relaystatetype\",{\"_index\":47,\"name\":{\"53\":{}},\"comment\":{}}],[\"repository\",{\"_index\":69,\"name\":{\"82\":{}},\"comment\":{}}],[\"sessionduration\",{\"_index\":46,\"name\":{\"52\":{}},\"comment\":{}}],[\"ssoconfig\",{\"_index\":19,\"name\":{\"19\":{},\"28\":{}},\"comment\":{}}],[\"ssopermissionconfig\",{\"_index\":48,\"name\":{\"54\":{}},\"comment\":{}}],[\"ssopermissionstack\",{\"_index\":57,\"name\":{\"63\":{}},\"comment\":{}}],[\"ssopermissionstackprops\",{\"_index\":56,\"name\":{\"62\":{}},\"comment\":{}}],[\"ssoprops\",{\"_index\":27,\"name\":{\"27\":{}},\"comment\":{}}],[\"ssostage\",{\"_index\":78,\"name\":{\"91\":{}},\"comment\":{}}],[\"ssostageconfig\",{\"_index\":75,\"name\":{\"88\":{}},\"comment\":{}}],[\"ssostageprops\",{\"_index\":77,\"name\":{\"90\":{}},\"comment\":{}}],[\"status\",{\"_index\":9,\"name\":{\"9\":{}},\"comment\":{}}]],\"pipeline\":[]}}"); \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA62c3XObSBLA/xf0yjqeYYZBfsvuZq9yldtNXVL3onKliBgrXDCoAMfrcuV/3xpAopvpRkj2U2qX/pr+9fR8CPwc1NVjE9xsnoPveZkFN7EKgzK9t8FNsLOlrdPWvt1uq4ey/SMvbBAGD3UR3AR3D+W2zauyeUNIXX1r74sgDLZF2jS2CW6C4Gc44+BTU/1WlXf57oQLJDfrROr46GUI7H15Vx1t52Vr67t0a5s34PGsSXEtx8jfZ0tMrToxYC0M9mlty3YSFePkT/fPEjeD4MWO3t2nebHI00HyYldv63KRo17uYjf/rvLSZv+x7bdqGamJwgsdf87vbdOm9/szfEOdi91/atP2oVnk9Sh6jjN5vTZCy+nc+pA37dFp+7Qf/bkn8zOVttjPc9pm/+wsq/+qq4c9aRM8WdxROh2unxwfLu8mvQpZqNjaapSkqY2RMa5+z5t9kT5xrWXiDktf6PLd362ty7R4n5GFOXGJpS8dpW22db53q8eSUSLp5S7JIiOmwvH/Ly6w40JHRX98uLzA8rJp03Jrme6LLa6wNJ2PMULOZWbLNm+fPrVVbenanrr1NC50vXP5Jmtt4vEouNwRpPRXvftY5+U236fF28e0JmeUJ7ScWgVU35U/lltf+Zr0CP0R0CP9rSrbuio+V4+2/lhXdHI9oeUjTfvGfobZFVChx+bHzM41dkiHZ8tH0pyYuWAEUJQtwGnki9OGfZHZapvsl7z5JS+/2TpvbXbC9bTdfah2vz5sv9v2U5tuv+Mc9o2PkJjPpEwY60fDg97E9KxVLcaYt1XZtPXDtq3qJSZXWJ6mNImUYXVXVI8fql3Ti6L1dy4AUu3MOIjD0K8P2c62f3Vr3tx2EcmdMZ/vnfJZdldHndn9KA6ccW9PnGcI73bJwYZzDhPcy/A9AD5fntCvnRZJyjO4GoXp0aAQ+fndi7GTe/p48cwGit4UAM9eZU5P7S2a0DBAbj1s2v/afVW3ebnjWRNiy5Fvj8pEy1jgZMUY4FZLf0QnA3tBSC8IZlqnSJotV0ZqcdX6+l6x+SKvUsOM2UWlTERNV/RHW9/nTZNX5afZdYGSW17T2fy5jDW+yhYc0cghsAeiIi/tx6rIt0/nRTLRfHko92mZ7mzWWczteUlf+covD6ixneDvD3V6Pihf+eUB1bZIn9x1lf38tCcbDh+Pp3tRONPzwlF6fq8/EVs+T7qD6ajObvApBytCmT9eTEfCbeiy+/xEZ2Dj8XVfHE5t0+yvsni6MCJS/cVBfc2LwnXZy2KitF8c0h6W9XnxeKqXBBNrHY0z58uXlpm/C6O4OlpYHMzVZBzswnSXPhTt26bJd+W9Ldvmj6r+0z4OG/+zYj5t65JUTnc9SJrd9TBSi3c9vr63PfFFXmXXw5hdtOshoj5vgpwKYmZyDJcq+zr/kbZ2cVSzM+W8cM6aJb0VdpKgk+3Qodp0Z2fOt57Uuafcs22vJnrMqc4P/+QB5/xQCN0LwvGO4kCYPItPny8/jANN//QMHr7OcXxqcNl5HMZI1+aHave23n7Lf8xU5lRmeV0WR82Z9YA0v6JU2es7PITZm9dBlK0ISuScu1eoTF1Uwuevdfvq2Vx6/YqCnbsoAL8I5HvbHeTIqwJG7ozLAt8Cca73hV7pwoAxvPDKgIidWz7PHtsKqLzcf233VZO3Vf10RgRI6RVygCpoQQIG+SVbhhNxyGuVgCNaRs9WPhSgclEePP/ej1/LYjj5Q9iZcQwLxiWxTFVfJZ6xRZ0XDNK7LBJ8cXFi74Yllq+P4/ax6VVnro4IH6sZfXYLu2zjdBBkzkYXrI0HLWpz/nqrITK29MwzrH+3YZCXmf07uHkOftjapTW4CeRVdLUOwuAut0XmXvjswwiDbXXvDqnB7fDsf9b5cRK9yJvrINxch0pcRSa5vQ03B43uQfc/OjERhBtBiQkkJoNwIykxicSiINxElFiExFQQbhQlppCYDsKNDqP4ShokpZFUHISbmDIWIzEThBtDiRkklgThJqHEEiS2DsLNmhJb4+y6ZAsSg5hw6EDQJDAK4VIuSBgC0xAu64LkITAQ4RIvSCQCMxEu+UKTkpiLcPkXJBmB0QiHQBiCtMBwhIMgSDwC8xGOg1hTJjEh6TBIkpDEhKTDIElCcjJZutlCTxdMSDoMkiQkMSHpMEiSkMSEpMMgSUISE5IOg4yJJEkMSDoMkpw9EhOSCZd3iQHJNesbA4o6QCTzCAOKOkDkrIwwoMhRiK5Dqa6uI4klJw2t62gk9AgDihyFiIQeYUCRoxDRbRIDimKmA0aYT+QgRIoSxHgiByEiayPCfCJHISJnb4QBKUchIotDYUBKsGlXGJDqAJHQFQakOkAkdDVZdLpVh5zpCgNSjoIioSsMSDkOioSuMCJl+LFjRsqBUGR5KMxIrbm+qTAi7TgosnlojEg7DoosEI0RacdBkQWiMSLtOCiyQDRGpDtEJHY92Rp0iEjsGiPS3RwisWuMSDsOmsSuMSLtOGgSu8aItAOhI2oTgxHFjoOmpnCMCcUOgyYJxZhQ7DBoemuECcUOgyYJxZhQrNgyjjGhWHMjjyf7t5gdOeYTd3zI6ogxnzjh+mGM8cQdHrKMYszHOAoxWUYGAzKOQkyWkcGADL8MGQzIOAoxWXAGAzKOQkx2D4MBGYchJpuCwYRMt8UmS85MNtl8lzMYkXEgYrI4DWZkHIiY3rpjRsk16z3BjJKOEb3Px4wSByImKyTBjBIHwpAVkmBGiQNhyApJMKPEgTAk9wQzShwIQ3JPMKOkOwmR3JPJWciBMCT3BDNKHAhD0kwwo7UDYUiaa8xo7UAYktEaM1rz82jdM+oO1z9s3drsfX/I3myOP9c9B1+Gk7c+Xo48B/F1cPP8Mwzi2P37czxxu/9yLoaXs/tfsarDr/+jsUiOxiI1b2Q7XO6M2kKM2kLMa+fdN02jLnAs5zWL7rMX4PUaeL2e10WDlTHwGfeZk2vOQJYN70344zbRaChhU59lRbVLD5dsQBsATAyv3TQV4RrkLdEzyv1FElAErBKWtHufpiErRYOsa3bMw4vWoMBAqiI2Xvc10KgDMHGOBjRMqCBHOjlhYZqnGOTJcDUNlX1GOgED4ABDE8O9PQgCJNtwJd5Pat99BOorMkODYNNweKEb6Gugf0Kvf20D6JpRV80H3ul6I48A/Iibm+jSEuiCrEWyH7gSw7+HRKj+XzM8N8P/T4ZOuuaa0ba/DW/dbfj4QxNABkZuZgL3jPjwQQoMl39kaWpBAoKSm3TudYK6e53ga/cOd39nC7K5Biijk0aIaQAMxHxGDgbIThuBqaR4NMCGV5IKdAPF9RPfhJdUBRqDOp3UaToVKE7F9d/h/a50fL/rrqpL+5gefuAH2QWMY65PoXebwQoKalUME0BxhLL+Q93peATwL7h0DJ++gKhBZ+79RhwSO3ytm2cIgwCzQ3C67tOmoto1TGUDkhFX2Yc/DDGk/q778xGjDUCTa3MHC8d1fGoD7p44G+6FW2LjBWpacNOi080zpAeWBsEVYa832a4JsI4LNmdO09uugSksuHbWaYLf6tDMAX1Ec5V2+N4WNEG4w+RyhNMD9yqsQv8lceO+JMbaEvCUHND+Hf/98I4/GCQgo7mKOnw9PdkvSVCMktP9f/eXIO6Hv0IB9oVgsZlVbcc/IjFqA7Yc2nETTHSxGKTccAU5WvBnQgwoGw7aaMDf7oGOZLh2MtH3V2wAz3AVWlS7vh15K5QEBR5xhYPV/SUfkIi4Ghg+6dgfP+kA9Qc7MxeDt6aBJY1Rqerd/vAZeNp/yA6CBvQlBw9asO6Dc6APApBcBKCrbPEbAGASgEUl4RZCYIg8digwGsXNBmQEn1qAul4Pu1WumMgdKJyMHEKvcAxoHgnHwH3VUJXFE3PeAo1Pc02k+1qmcV/LTC80FGhBmo9gfLMKDBnMnITr8cN3QxnBXQHumtWnzuECeBYDLclBb5pq5O7bUgCc5soY2fBaiAY5jLkc+ia8atDw7D2TEL//gAAkVwNNU/n3EmDwa65qD4rEfQjoW8lM/unGbUDUa65rNsNfMxrVAHuyWdyG4wS92dz+/PkP1a503AtNAAA="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 496e66f..98a4377 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -6,17 +6,36 @@ --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: #707070; - --light-color-link: #4da6ff; - --light-color-ts: #db1373; - --light-color-ts-interface: #139d2c; - --light-color-ts-enum: #9c891a; - --light-color-ts-class: #2484e5; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --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-namespace: #b111c9; - --light-color-ts-private: #707070; - --light-color-ts-variable: #4d68ff; + --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: #a55c0e; + --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); + --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; @@ -27,17 +46,36 @@ --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: #ff6492; - --dark-color-ts-interface: #6cff87; + + --dark-color-ts-keyword: #3399ff; + --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-class: #61b0ff; - --dark-color-ts-function: #9772ff; - --dark-color-ts-namespace: #e14dff; - --dark-color-ts-private: #e2e2e2; - --dark-color-ts-variable: #4d68ff; + --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: #e07d13; + --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); + --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; } @@ -50,17 +88,35 @@ --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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -74,17 +130,35 @@ --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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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); } @@ -105,17 +179,35 @@ body { --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: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-function: var(--light-color-ts-function); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-private: var(--light-color-ts-private); + --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); } @@ -127,17 +219,35 @@ body { --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: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-function: var(--dark-color-ts-function); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-private: var(--dark-color-ts-private); + --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); } @@ -156,6 +266,16 @@ h6 { line-height: 1.2; } +h1 > a:not(.link), +h2 > a:not(.link), +h3 > a:not(.link), +h4 > a:not(.link), +h5 > a:not(.link), +h6 > a:not(.link) { + text-decoration: none; + color: var(--color-text); +} + h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -190,12 +310,6 @@ h6 { text-transform: uppercase; } -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - dl, menu, ol, @@ -208,26 +322,10 @@ dd { } .container { - max-width: 1600px; + max-width: 1700px; padding: 0 2rem; } -@media (min-width: 640px) { - .container { - padding: 0 4rem; - } -} -@media (min-width: 1200px) { - .container { - padding: 0 8rem; - } -} -@media (min-width: 1600px) { - .container { - padding: 0 12rem; - } -} - /* Footer */ .tsd-generator { border-top: 1px solid var(--color-accent); @@ -243,26 +341,9 @@ dd { } .container-main { - display: flex; - justify-content: space-between; - position: relative; margin: 0 auto; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 2rem 1rem; -} - -.col-4 { - flex: 0 0 25%; -} -.col-8 { - flex: 1 0; - flex-wrap: wrap; - padding-left: 0; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { @@ -305,22 +386,6 @@ dd { opacity: 0; } } -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} @keyframes pop-in-from-right { from { transform: translate(100%, 0); @@ -369,13 +434,29 @@ pre { } pre { + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; padding: 10px; - border: 0.1em solid var(--color-accent); + 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; @@ -391,13 +472,12 @@ blockquote { padding: 0 0 0 20px; margin: 0; } -.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, +.tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { font-size: 1em; - margin: 0; } .tsd-typography h5, .tsd-typography h6 { @@ -408,90 +488,18 @@ blockquote { .tsd-typography ol { margin: 1em 0; } - -@media (max-width: 1024px) { - html .col-content { - float: none; - max-width: 100%; - width: 100%; - padding-top: 3rem; - } - html .col-menu { - 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; - max-width: 25rem; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-menu > *: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 :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - 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%; - } +.tsd-typography table { + border-collapse: collapse; + border: none; +} +.tsd-typography td, +.tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); +} +.tsd-typography thead, +.tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } .tsd-breadcrumb { @@ -641,6 +649,28 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { font-weight: bold; } +.tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); +} +.tsd-full-hierarchy, +.tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; +} +.tsd-full-hierarchy ul { + padding-left: 1.5rem; +} +.tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); +} + .tsd-panel-group.tsd-index-group { margin-bottom: 0; } @@ -672,43 +702,6 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { -o-page-break-inside: avoid; page-break-inside: avoid; } -.tsd-index-panel a, -.tsd-index-panel a.tsd-parent-kind-module { - color: var(--color-ts); -} -.tsd-index-panel a.tsd-parent-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-parent-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-parent-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-module { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-index-panel a.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-index-panel a.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-index-panel a.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-index-panel a.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-index-panel a.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-index-panel a.tsd-is-private { - color: var(--color-ts-private); -} .tsd-flag { display: inline-block; @@ -723,7 +716,7 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } .tsd-anchor { - position: absolute; + position: relative; top: -100px; } @@ -737,108 +730,62 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-bottom: 0; border-bottom: none; } -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); + +.tsd-navigation.settings { + margin: 1rem 0; } -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); +.tsd-navigation > a, +.tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } - -.tsd-navigation a { - display: block; - margin: 0.4rem 0; - border-left: 2px solid transparent; +.tsd-navigation a, +.tsd-navigation summary > span, +.tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; color: var(--color-text); text-decoration: none; - transition: border-left-color 0.1s; + box-sizing: border-box; +} +.tsd-navigation a.current, +.tsd-page-navigation a.current { + background: var(--color-active-menu-item); } -.tsd-navigation a:hover { +.tsd-navigation a:hover, +.tsd-page-navigation a:hover { text-decoration: underline; } -.tsd-navigation ul { - margin: 0; +.tsd-navigation ul, +.tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; padding: 0; list-style: none; } -.tsd-navigation li { +.tsd-navigation li, +.tsd-page-navigation li { padding: 0; + max-width: 100%; } - -.tsd-navigation.primary .tsd-accordion-details > ul { - margin-top: 0.75rem; +.tsd-nested-navigation { + margin-left: 3rem; } -.tsd-navigation.primary a { - padding: 0.75rem 0.5rem; - margin: 0; +.tsd-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.primary ul li a { - margin-left: 0.5rem; -} -.tsd-navigation.primary ul li li a { +.tsd-small-nested-navigation { margin-left: 1.5rem; } -.tsd-navigation.primary ul li li li a { - margin-left: 2.5rem; -} -.tsd-navigation.primary ul li li li li a { - margin-left: 3.5rem; -} -.tsd-navigation.primary ul li li li li li a { - margin-left: 4.5rem; -} -.tsd-navigation.primary ul li li li li li li a { - margin-left: 5.5rem; -} -.tsd-navigation.primary li.current > a { - border-left: 0.15rem var(--color-text) solid; -} -.tsd-navigation.primary li.selected > a { - font-weight: bold; - border-left: 0.2rem var(--color-text) solid; -} -.tsd-navigation.primary ul li a:hover { - border-left: 0.2rem var(--color-text-aside) solid; -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; +.tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; } -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary > ul { - display: inline; - padding-right: 0.5rem; - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 0; -} -.tsd-navigation.secondary ul li li a { - padding-left: 1.1rem; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 2.2rem; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 3.3rem; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 4.4rem; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 5.5rem; +.tsd-page-navigation ul { + padding-left: 1.75rem; } #tsd-sidebar-links a { @@ -851,41 +798,40 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { } a.tsd-index-link { - margin: 0.25rem 0; + 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 > h1, -.tsd-accordion-summary > h2, -.tsd-accordion-summary > h3, -.tsd-accordion-summary > h4, -.tsd-accordion-summary > h5 { - display: inline-flex; - align-items: center; - vertical-align: middle; - margin-bottom: 0; +.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; -} -.tsd-accordion-summary { - display: block; + 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-accordion-summary::-webkit-details-marker { - display: none; -} -.tsd-index-accordion .tsd-accordion-summary svg { - margin-right: 0.25rem; +.tsd-index-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -910,34 +856,6 @@ a.tsd-index-link { margin-right: 0.8rem; } -@media (min-width: 1025px) { - .col-content { - margin: 2rem auto; - } - - .menu-sticky-wrap { - position: sticky; - height: calc(100vh - 2rem); - top: 4rem; - right: 0; - padding: 0 1.5rem; - padding-top: 1rem; - margin-top: 3rem; - transition: 0.3s ease-in-out; - transition-property: top, padding-top, padding, height; - overflow-y: auto; - } - .col-menu { - border-left: 1px solid var(--color-accent); - } - .col-menu--hide { - top: 1rem; - } - .col-menu .tsd-navigation:not(:last-child) { - padding-bottom: 1.75rem; - } -} - .tsd-panel { margin-bottom: 2.5rem; } @@ -1018,8 +936,9 @@ a.tsd-index-link { box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - padding: 0 10px; background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { background-color: var(--color-background-secondary); @@ -1027,12 +946,15 @@ a.tsd-index-link { #tsd-search .results li.state { display: none; } -#tsd-search .results li.current, -#tsd-search .results li:hover { +#tsd-search .results li.current:not(.no-results), +#tsd-search .results li:hover:not(.no-results) { background-color: var(--color-accent); } #tsd-search .results a { - display: block; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { top: 10px; @@ -1088,6 +1010,11 @@ a.tsd-index-link { overflow-x: auto; } +.tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; +} + .tsd-signature-symbol { color: var(--color-text-aside); font-weight: normal; @@ -1143,7 +1070,7 @@ ul.tsd-type-parameter-list h5 { } .tsd-page-toolbar { - position: fixed; + position: sticky; z-index: 1; top: 0; left: 0; @@ -1183,16 +1110,14 @@ ul.tsd-type-parameter-list h5 { padding: 12px 0; } -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - .tsd-widget { display: inline-block; overflow: hidden; opacity: 0.8; height: 40px; - transition: opacity 0.1s, background-color 0.2s; + transition: + opacity 0.1s, + background-color 0.2s; vertical-align: bottom; cursor: pointer; } @@ -1214,12 +1139,6 @@ ul.tsd-type-parameter-list h5 { .tsd-widget.menu { display: none; } -@media (max-width: 1024px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} input[type="checkbox"] + .tsd-widget:before { background-position: -120px 0; } @@ -1250,7 +1169,7 @@ img { } .deprecated { - text-decoration: line-through; + text-decoration: line-through !important; } .warning { @@ -1259,6 +1178,78 @@ img { 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); @@ -1277,3 +1268,147 @@ img { 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/docs/classes/BillingStage.html b/docs/classes/BillingStage.html index 5d2cde9..3815128 100644 --- a/docs/classes/BillingStage.html +++ b/docs/classes/BillingStage.html @@ -1,267 +1,40 @@ -BillingStage | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class BillingStage<T>

-
-

Type Parameters

-
    -
  • -

    T extends string

-
-

Hierarchy

-
    -
  • Stage -
      -
    • BillingStage
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account? -node -parentStage? -region? -stageName -
-
-

Accessors

-
artifactId -assetOutdir -outdir -
-
-

Methods

-
synth -toString -isConstruct -isStage -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional Readonly account

-
account?: string
-

The default account for all resources defined within this stage.

-
-
-

Readonly node

-
node: Node
-

The tree node.

- -

Stability

stable

-
-
-

Optional Readonly parentStage

-
parentStage?: Stage
-

The parent stage or undefined if this is the app. +BillingStage | @taimos/cdk-controltower

Class BillingStage<T>

Type Parameters

  • T extends string

Hierarchy

  • Stage
    • BillingStage

Constructors

constructor +

Properties

account? +node +parentStage? +region? +stageName +

Accessors

artifactId +assetOutdir +outdir +

Methods

synth +toString +isConstruct +isStage +of +

Constructors

constructor

Properties

Optional Readonly account

account?: string

The default account for all resources defined within this stage.

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

Optional Readonly parentStage

parentStage?: Stage

The parent stage or undefined if this is the app. *

-
-
-

Optional Readonly region

-
region?: string
-

The default region for all resources defined within this stage.

-
-
-

Readonly stageName

-
stageName: string
-

The name of the stage. Based on names of the parent stages separated by +

Optional Readonly region

region?: string

The default region for all resources defined within this stage.

+

Readonly stageName

stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

-
-
-

Accessors

-
-

artifactId

-
    -
  • get artifactId(): string
    • -
  • -

    Artifact ID of the assembly if it is a nested stage. The root stage (app) +

Accessors

artifactId

  • get artifactId(): string

  • Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.

    Derived from the construct path.

    -
    -

    Returns string

-
-

assetOutdir

-
    -
  • get assetOutdir(): string
    • -
  • -

    The cloud assembly asset output directory.

    -
    -

    Returns string

-
-

outdir

-
    -
  • get outdir(): string
    • -
  • -

    The cloud assembly output directory.

    -
    -

    Returns string

-
-

Methods

-
-

synth

-
    - -
  • -

    Synthesize this stage into a cloud assembly.

    +

    Returns string

assetOutdir

  • get assetOutdir(): string

  • The cloud assembly asset output directory.

    +

    Returns string

outdir

  • get outdir(): string

  • The cloud assembly output directory.

    +

    Returns string

Methods

synth

  • synth(options?): CloudAssembly

  • Synthesize this stage into a cloud assembly.

    Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional options: StageSynthesisOptions
    -

    Returns CloudAssembly

-
-

toString

-
    - -
  • -

    Returns a string representation of this construct.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStage

-
    - -
  • -

    Test whether the given construct is a stage.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
    -

    Returns x is Stage

-
-

Static of

-
    - -
  • -

    Return the stage this construct is contained with, if available. If called +

    Parameters

    • Optional options: StageSynthesisOptions

    Returns CloudAssembly

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStage

  • isStage(x): x is Stage

  • Test whether the given construct is a stage.

    +

    Parameters

    • x: any

    Returns x is Stage

Static of

  • of(construct): undefined | Stage

  • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

    -
    -
    -

    Parameters

    -
      -
    • -
      construct: IConstruct
    -

    Returns undefined | Stage

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • construct: IConstruct

Returns undefined | Stage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/BudgetStack.html b/docs/classes/BudgetStack.html index a076f06..f3e7ca3 100644 --- a/docs/classes/BudgetStack.html +++ b/docs/classes/BudgetStack.html @@ -1,116 +1,43 @@ -BudgetStack | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class BudgetStack<T>

-
-

Type Parameters

-
    -
  • -

    T extends string

-
-

Hierarchy

-
    -
  • Stack -
      -
    • BudgetStack
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account -artifactId -environment -nestedStackResource? -node -region -synthesizer -tags -templateFile -templateOptions -terminationProtection? -
-
-

Accessors

-
availabilityZones -bundlingRequired -dependencies -maxResources -nested -nestedStackParent -notificationArns -partition -stackId -stackName -urlSuffix -
-
-

Methods

-
addDependency -addTransform -allocateLogicalId -exportValue -formatArn -getLogicalId -regionalFact -renameLogicalId -reportMissingContextKey -resolve -splitArn -toJsonString -toString -isConstruct -isStack -of -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends string

    -
    -

    Parameters

    -
    -

    Returns BudgetStack<T>

-
-

Properties

-
-

Readonly account

-
account: string
-

The AWS account into which this stack will be deployed.

+BudgetStack | @taimos/cdk-controltower

Class BudgetStack<T>

Type Parameters

  • T extends string

Hierarchy

  • Stack
    • BudgetStack

Constructors

constructor +

Properties

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

Accessors

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

Methods

addDependency +addTransform +allocateLogicalId +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +isConstruct +isStack +of +

Constructors

constructor

Properties

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 @@ -127,18 +54,8 @@

    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 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 +

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 @@ -147,27 +64,11 @@

ReadonlyAws.account 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 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.

- -

Stability

stable

-
-
-

Readonly region

-
region: string
-

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

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

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 @@ -184,48 +85,14 @@

    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 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 +

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 +

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 @@ -235,91 +102,18 @@

    availabilityZonesReturns 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

    +

    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

-
-

stackId

-
    -
  • get stackId(): string
    • -
  • -

    The ID of the stack

    - -

    Example

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

    Returns string

-
-

stackName

-
    -
  • get stackName(): string
    • -
  • -

    The concrete CloudFormation physical stack name.

    +

    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

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

-
-

urlSuffix

-
    -
  • get urlSuffix(): string
    • -
  • -

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

    -
    -

    Returns string

-
-

Methods

-
-

addDependency

-
    - -
  • -

    Add a dependency between this stack and another stack.

    +

    Returns string

urlSuffix

  • get urlSuffix(): string

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

    +

    Returns string

Methods

addDependency

  • addDependency(target, reason?): 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

-
-

addTransform

-
    - -
  • -

    Add a Transform to this stack. A Transform is a macro that AWS +

    Parameters

    • target: Stack
    • Optional reason: string

    Returns void

addTransform

  • addTransform(transform): 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.

    - -

    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')
-
    -
    -
    -

    Parameters

    -
      -
    • -
      transform: string
      -

      The transform to add

      -
    -

    Returns void

-
-

Protected allocateLogicalId

-

Protected allocateLogicalId

  • allocateLogicalId(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 @@ -418,22 +163,8 @@

    Protected

-
-
-

Parameters

-
    -
  • -
    cfnElement: CfnElement
    -

    The element for which the logical ID is allocated.

    -
-

Returns string

-
-

exportValue

-
    - -
  • -

    Create a CloudFormation Export for a value

    +

    Parameters

    • cfnElement: CfnElement

      The element for which the logical ID is allocated.

      +

    Returns string

exportValue

  • exportValue(exportedValue, options?): string

  • Create a CloudFormation Export for a 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.

    @@ -446,22 +177,14 @@

    exportValue - - -

    Example

    -     -

    Here is how the process works. Let's say there are two stacks, +

    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

    -     -
      +

      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).
        • @@ -470,31 +193,12 @@

        Deployment 1: break 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

      -       -
        +

        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.

    +

    Parameters

    • exportedValue: any
    • Optional options: ExportValueOptions

    Returns string

formatArn

-
-

getLogicalId

-
    - -
  • -

    Allocates a stack-unique CloudFormation-compatible logical identity for a +

    Parameters

    • components: ArnComponents

    Returns string

getLogicalId

-
-

regionalFact

-
    - -
  • -

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

    +

Returns string

regionalFact

-
-

renameLogicalId

-
    - -
  • -

    Rename a generated logical identities

    +

    Parameters

    • factName: string
    • Optional defaultValue: string

    Returns string

renameLogicalId

  • renameLogicalId(oldId, newId): 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

-
-

reportMissingContextKey

-
    - -
  • -

    Indicate that a context key was expected

    +

    Parameters

    • oldId: string
    • newId: string

    Returns void

reportMissingContextKey

  • reportMissingContextKey(report): 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

-
-

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. +

    Parameters

    • report: MissingContext

      The set of parameters needed to obtain the context

      +

    Returns void

resolve

  • resolve(obj): any

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

    +

    Parameters

    • obj: any

    Returns any

splitArn

  • splitArn(arn, 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

-
-

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.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStack

-
    - -
  • -

    Return whether the given object is a Stack.

    +

    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

  • toJsonString(obj, space?): string

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

    +

    Parameters

    • obj: any
    • Optional space: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStack

  • isStack(x): 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

-
-

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

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • x: any

Returns x is Stack

Static of

  • of(construct): 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ControlTowerPipeline.html b/docs/classes/ControlTowerPipeline.html index 61ee9e1..d6128ad 100644 --- a/docs/classes/ControlTowerPipeline.html +++ b/docs/classes/ControlTowerPipeline.html @@ -1,125 +1,50 @@ -ControlTowerPipeline | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class ControlTowerPipeline<T, S>

-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-

Hierarchy

-
    -
  • Stack -
      -
    • ControlTowerPipeline
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account -artifactId -environment -nestedStackResource? -node -pipeline -props -region -repository -synthesizer -tags -templateFile -templateOptions -terminationProtection? -
-
-

Accessors

-
availabilityZones -bundlingRequired -dependencies -maxResources -nested -nestedStackParent -notificationArns -partition -stackId -stackName -urlSuffix -
-
-

Methods

-
addBillingConfig -addDependency -addLogArchive -addSsoConfig -addStage -addTransform -allocateLogicalId -exportValue -formatArn -getLogicalId -regionalFact -renameLogicalId -reportMissingContextKey -resolve -splitArn -toJsonString -toString -isConstruct -isStack -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly account

-
account: string
-

The AWS account into which this stack will be deployed.

+ControlTowerPipeline | @taimos/cdk-controltower

Class ControlTowerPipeline<T, S>

Type Parameters

  • T extends string

  • S extends string

Hierarchy

  • Stack
    • ControlTowerPipeline

Constructors

constructor +

Properties

account +artifactId +environment +nestedStackResource? +node +pipeline +props +region +repository +synthesizer +tags +templateFile +templateOptions +terminationProtection? +

Accessors

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

Methods

addBillingConfig +addDependency +addLogArchive +addSsoConfig +addStage +addTransform +allocateLogicalId +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +isConstruct +isStack +of +

Constructors

constructor

Properties

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 @@ -136,18 +61,8 @@

    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 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 +

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 @@ -156,33 +71,11 @@

ReadonlyAws.account 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 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.

- -

Stability

stable

-
-
-

Readonly pipeline

-
pipeline: CodePipeline
-
-

Private props

-
props: ControlTowerPipelineProps<T, S>
-
-

Readonly region

-
region: string
-

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

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

Readonly pipeline

pipeline: CodePipeline

Private props

props: ControlTowerPipelineProps<T, S>

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 @@ -199,51 +92,14 @@

    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 repository

-
repository: Repository
-
-

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 +

Readonly repository

repository: Repository

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 +

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 @@ -253,91 +109,18 @@

    availabilityZonesReturns 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

    +

    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

-
-

stackId

-
    -
  • get stackId(): string
    • -
  • -

    The ID of the stack

    - -

    Example

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

    Returns string

-
-

stackName

-
    -
  • get stackName(): string
    • -
  • -

    The concrete CloudFormation physical stack name.

    +

    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

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

-
-

urlSuffix

-
    -
  • get urlSuffix(): string
    • -
  • -

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

    -
    -

    Returns string

-
-

Methods

-
-

addBillingConfig

-
-
-

addDependency

-
    - -
  • -

    Add a dependency between this stack and another stack.

    +

    Returns string

urlSuffix

  • get urlSuffix(): string

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

    +

    Returns string

Methods

addBillingConfig

  • addBillingConfig(budgetConfig?, costReportConfig?): void

  • Parameters

    Returns void

addDependency

  • addDependency(target, reason?): 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

-
-

addLogArchive

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      logArchiveAccount: T
    -

    Returns void

-
-

addSsoConfig

-
-
-

addStage

-
    - -
  • -
    -

    Parameters

    -
      -
    • -
      appStage: Stage
      • -
    • -
      Optional options: AddStageOpts
    -

    Returns StageDeployment

-
-

addTransform

-
    - -
  • -

    Add a Transform to this stack. A Transform is a macro that AWS +

    Parameters

    • target: Stack
    • Optional reason: string

    Returns void

addLogArchive

  • addLogArchive(logArchiveAccount): void

  • Parameters

    • logArchiveAccount: T

    Returns void

addSsoConfig

  • addSsoConfig(permissionsConfiguration?): void

  • Parameters

    Returns void

addStage

  • addStage(appStage, options?): StageDeployment

  • Parameters

    • appStage: Stage
    • Optional options: AddStageOpts

    Returns StageDeployment

addTransform

  • addTransform(transform): 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.

    - -

    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')
-
    -
    -
    -

    Parameters

    -
      -
    • -
      transform: string
      -

      The transform to add

      -
    -

    Returns void

-
-

Protected allocateLogicalId

-

Protected allocateLogicalId

  • allocateLogicalId(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 @@ -484,22 +170,8 @@

    Protected

-
-
-

Parameters

-
    -
  • -
    cfnElement: CfnElement
    -

    The element for which the logical ID is allocated.

    -
-

Returns string

-
-

exportValue

-
    - -
  • -

    Create a CloudFormation Export for a value

    +

    Parameters

    • cfnElement: CfnElement

      The element for which the logical ID is allocated.

      +

    Returns string

exportValue

  • exportValue(exportedValue, options?): string

  • Create a CloudFormation Export for a 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.

    @@ -512,22 +184,14 @@

    exportValue - - -

    Example

    -     -

    Here is how the process works. Let's say there are two stacks, +

    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

    -     -
      +

      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).
        • @@ -536,31 +200,12 @@

        Deployment 1: break 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

      -       -
        +

        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.

    +

    Parameters

    • exportedValue: any
    • Optional options: ExportValueOptions

    Returns string

formatArn

-
-

getLogicalId

-
    - -
  • -

    Allocates a stack-unique CloudFormation-compatible logical identity for a +

    Parameters

    • components: ArnComponents

    Returns string

getLogicalId

-
-

regionalFact

-
    - -
  • -

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

    +

Returns string

regionalFact

-
-

renameLogicalId

-
    - -
  • -

    Rename a generated logical identities

    +

    Parameters

    • factName: string
    • Optional defaultValue: string

    Returns string

renameLogicalId

  • renameLogicalId(oldId, newId): 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

-
-

reportMissingContextKey

-
    - -
  • -

    Indicate that a context key was expected

    +

    Parameters

    • oldId: string
    • newId: string

    Returns void

reportMissingContextKey

  • reportMissingContextKey(report): 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

-
-

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. +

    Parameters

    • report: MissingContext

      The set of parameters needed to obtain the context

      +

    Returns void

resolve

  • resolve(obj): any

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

    +

    Parameters

    • obj: any

    Returns any

splitArn

  • splitArn(arn, 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

-
-

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.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStack

-
    - -
  • -

    Return whether the given object is a Stack.

    +

    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

  • toJsonString(obj, space?): string

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

    +

    Parameters

    • obj: any
    • Optional space: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStack

  • isStack(x): 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

-
-

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

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • x: any

Returns x is Stack

Static of

  • of(construct): 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/CostReportingStack.html b/docs/classes/CostReportingStack.html index cdb0980..1f5edd2 100644 --- a/docs/classes/CostReportingStack.html +++ b/docs/classes/CostReportingStack.html @@ -1,106 +1,43 @@ -CostReportingStack | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class CostReportingStack

-
-

Hierarchy

-
    -
  • Stack -
      -
    • CostReportingStack
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account -artifactId -environment -nestedStackResource? -node -region -synthesizer -tags -templateFile -templateOptions -terminationProtection? -
-
-

Accessors

-
availabilityZones -bundlingRequired -dependencies -maxResources -nested -nestedStackParent -notificationArns -partition -stackId -stackName -urlSuffix -
-
-

Methods

-
addDependency -addTransform -allocateLogicalId -exportValue -formatArn -getLogicalId -regionalFact -renameLogicalId -reportMissingContextKey -resolve -splitArn -toJsonString -toString -isConstruct -isStack -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly account

-
account: string
-

The AWS account into which this stack will be deployed.

+CostReportingStack | @taimos/cdk-controltower

Class CostReportingStack

Hierarchy

  • Stack
    • CostReportingStack

Constructors

constructor +

Properties

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

Accessors

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

Methods

addDependency +addTransform +allocateLogicalId +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +isConstruct +isStack +of +

Constructors

constructor

Properties

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 @@ -117,18 +54,8 @@

    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 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 +

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 @@ -137,27 +64,11 @@

ReadonlyAws.account 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 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.

- -

Stability

stable

-
-
-

Readonly region

-
region: string
-

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

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

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 @@ -174,48 +85,14 @@

    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 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 +

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 +

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 @@ -225,91 +102,18 @@

    availabilityZonesReturns 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

    +

    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

-
-

stackId

-
    -
  • get stackId(): string
    • -
  • -

    The ID of the stack

    - -

    Example

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

    Returns string

-
-

stackName

-
    -
  • get stackName(): string
    • -
  • -

    The concrete CloudFormation physical stack name.

    +

    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

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

-
-

urlSuffix

-
    -
  • get urlSuffix(): string
    • -
  • -

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

    -
    -

    Returns string

-
-

Methods

-
-

addDependency

-
    - -
  • -

    Add a dependency between this stack and another stack.

    +

    Returns string

urlSuffix

  • get urlSuffix(): string

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

    +

    Returns string

Methods

addDependency

  • addDependency(target, reason?): 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

-
-

addTransform

-
    - -
  • -

    Add a Transform to this stack. A Transform is a macro that AWS +

    Parameters

    • target: Stack
    • Optional reason: string

    Returns void

addTransform

  • addTransform(transform): 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.

    - -

    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')
-
    -
    -
    -

    Parameters

    -
      -
    • -
      transform: string
      -

      The transform to add

      -
    -

    Returns void

-
-

Protected allocateLogicalId

-

Protected allocateLogicalId

  • allocateLogicalId(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 @@ -408,22 +163,8 @@

    Protected

-
-
-

Parameters

-
    -
  • -
    cfnElement: CfnElement
    -

    The element for which the logical ID is allocated.

    -
-

Returns string

-
-

exportValue

-
    - -
  • -

    Create a CloudFormation Export for a value

    +

    Parameters

    • cfnElement: CfnElement

      The element for which the logical ID is allocated.

      +

    Returns string

exportValue

  • exportValue(exportedValue, options?): string

  • Create a CloudFormation Export for a 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.

    @@ -436,22 +177,14 @@

    exportValue - - -

    Example

    -     -

    Here is how the process works. Let's say there are two stacks, +

    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

    -     -
      +

      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).
        • @@ -460,31 +193,12 @@

        Deployment 1: break 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

      -       -
        +

        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.

    +

    Parameters

    • exportedValue: any
    • Optional options: ExportValueOptions

    Returns string

formatArn

-
-

getLogicalId

-
    - -
  • -

    Allocates a stack-unique CloudFormation-compatible logical identity for a +

    Parameters

    • components: ArnComponents

    Returns string

getLogicalId

-
-

regionalFact

-
    - -
  • -

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

    +

Returns string

regionalFact

-
-

renameLogicalId

-
    - -
  • -

    Rename a generated logical identities

    +

    Parameters

    • factName: string
    • Optional defaultValue: string

    Returns string

renameLogicalId

  • renameLogicalId(oldId, newId): 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

-
-

reportMissingContextKey

-
    - -
  • -

    Indicate that a context key was expected

    +

    Parameters

    • oldId: string
    • newId: string

    Returns void

reportMissingContextKey

  • reportMissingContextKey(report): 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

-
-

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. +

    Parameters

    • report: MissingContext

      The set of parameters needed to obtain the context

      +

    Returns void

resolve

  • resolve(obj): any

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

    +

    Parameters

    • obj: any

    Returns any

splitArn

  • splitArn(arn, 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

-
-

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.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStack

-
    - -
  • -

    Return whether the given object is a Stack.

    +

    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

  • toJsonString(obj, space?): string

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

    +

    Parameters

    • obj: any
    • Optional space: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStack

  • isStack(x): 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

-
-

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

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • x: any

Returns x is Stack

Static of

  • of(construct): 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/LogArchiveStage.html b/docs/classes/LogArchiveStage.html index 0a6e601..92c5bd0 100644 --- a/docs/classes/LogArchiveStage.html +++ b/docs/classes/LogArchiveStage.html @@ -1,257 +1,40 @@ -LogArchiveStage | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class LogArchiveStage

-
-

Hierarchy

-
    -
  • Stage -
      -
    • LogArchiveStage
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account? -node -parentStage? -region? -stageName -
-
-

Accessors

-
artifactId -assetOutdir -outdir -
-
-

Methods

-
synth -toString -isConstruct -isStage -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Optional Readonly account

-
account?: string
-

The default account for all resources defined within this stage.

-
-
-

Readonly node

-
node: Node
-

The tree node.

- -

Stability

stable

-
-
-

Optional Readonly parentStage

-
parentStage?: Stage
-

The parent stage or undefined if this is the app. +LogArchiveStage | @taimos/cdk-controltower

Class LogArchiveStage

Hierarchy

  • Stage
    • LogArchiveStage

Constructors

constructor +

Properties

account? +node +parentStage? +region? +stageName +

Accessors

artifactId +assetOutdir +outdir +

Methods

synth +toString +isConstruct +isStage +of +

Constructors

constructor

Properties

Optional Readonly account

account?: string

The default account for all resources defined within this stage.

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

Optional Readonly parentStage

parentStage?: Stage

The parent stage or undefined if this is the app. *

-
-
-

Optional Readonly region

-
region?: string
-

The default region for all resources defined within this stage.

-
-
-

Readonly stageName

-
stageName: string
-

The name of the stage. Based on names of the parent stages separated by +

Optional Readonly region

region?: string

The default region for all resources defined within this stage.

+

Readonly stageName

stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

-
-
-

Accessors

-
-

artifactId

-
    -
  • get artifactId(): string
    • -
  • -

    Artifact ID of the assembly if it is a nested stage. The root stage (app) +

Accessors

artifactId

  • get artifactId(): string

  • Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.

    Derived from the construct path.

    -
    -

    Returns string

-
-

assetOutdir

-
    -
  • get assetOutdir(): string
    • -
  • -

    The cloud assembly asset output directory.

    -
    -

    Returns string

-
-

outdir

-
    -
  • get outdir(): string
    • -
  • -

    The cloud assembly output directory.

    -
    -

    Returns string

-
-

Methods

-
-

synth

-
    - -
  • -

    Synthesize this stage into a cloud assembly.

    +

    Returns string

assetOutdir

  • get assetOutdir(): string

  • The cloud assembly asset output directory.

    +

    Returns string

outdir

  • get outdir(): string

  • The cloud assembly output directory.

    +

    Returns string

Methods

synth

  • synth(options?): CloudAssembly

  • Synthesize this stage into a cloud assembly.

    Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional options: StageSynthesisOptions
    -

    Returns CloudAssembly

-
-

toString

-
    - -
  • -

    Returns a string representation of this construct.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStage

-
    - -
  • -

    Test whether the given construct is a stage.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
    -

    Returns x is Stage

-
-

Static of

-
    - -
  • -

    Return the stage this construct is contained with, if available. If called +

    Parameters

    • Optional options: StageSynthesisOptions

    Returns CloudAssembly

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStage

  • isStage(x): x is Stage

  • Test whether the given construct is a stage.

    +

    Parameters

    • x: any

    Returns x is Stage

Static of

  • of(construct): undefined | Stage

  • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

    -
    -
    -

    Parameters

    -
      -
    • -
      construct: IConstruct
    -

    Returns undefined | Stage

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • construct: IConstruct

Returns undefined | Stage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/LogBucketStack.html b/docs/classes/LogBucketStack.html index 2bc556e..6f65363 100644 --- a/docs/classes/LogBucketStack.html +++ b/docs/classes/LogBucketStack.html @@ -1,107 +1,44 @@ -LogBucketStack | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class LogBucketStack

-
-

Hierarchy

-
    -
  • Stack -
      -
    • LogBucketStack
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account -artifactId -environment -flowLogsBucketName -nestedStackResource? -node -region -synthesizer -tags -templateFile -templateOptions -terminationProtection? -
-
-

Accessors

-
availabilityZones -bundlingRequired -dependencies -maxResources -nested -nestedStackParent -notificationArns -partition -stackId -stackName -urlSuffix -
-
-

Methods

-
addDependency -addTransform -allocateLogicalId -exportValue -formatArn -getLogicalId -regionalFact -renameLogicalId -reportMissingContextKey -resolve -splitArn -toJsonString -toString -isConstruct -isStack -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly account

-
account: string
-

The AWS account into which this stack will be deployed.

+LogBucketStack | @taimos/cdk-controltower

Class LogBucketStack

Hierarchy

  • Stack
    • LogBucketStack

Constructors

constructor +

Properties

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

Accessors

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

Methods

addDependency +addTransform +allocateLogicalId +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +isConstruct +isStack +of +

Constructors

constructor

Properties

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 @@ -118,18 +55,8 @@

    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 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 +

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 @@ -138,30 +65,11 @@

ReadonlyAws.account or Aws.region) the special strings unknown-account and/or unknown-region will be used respectively to indicate this stack is region/account-agnostic.

-

-
-

Readonly flowLogsBucketName

-
flowLogsBucketName: string
-
-

Optional Readonly nestedStackResource

-
nestedStackResource?: CfnResource
-

If this is a nested stack, this represents its AWS::CloudFormation::Stack +

Readonly flowLogsBucketName

flowLogsBucketName: string

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.

- -

Stability

stable

-
-
-

Readonly region

-
region: string
-

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

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

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 @@ -178,48 +86,14 @@

    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 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 +

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 +

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 @@ -229,91 +103,18 @@

    availabilityZonesReturns 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

    +

    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

-
-

stackId

-
    -
  • get stackId(): string
    • -
  • -

    The ID of the stack

    - -

    Example

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

    Returns string

-
-

stackName

-
    -
  • get stackName(): string
    • -
  • -

    The concrete CloudFormation physical stack name.

    +

    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

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

-
-

urlSuffix

-
    -
  • get urlSuffix(): string
    • -
  • -

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

    -
    -

    Returns string

-
-

Methods

-
-

addDependency

-
    - -
  • -

    Add a dependency between this stack and another stack.

    +

    Returns string

urlSuffix

  • get urlSuffix(): string

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

    +

    Returns string

Methods

addDependency

  • addDependency(target, reason?): 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

-
-

addTransform

-
    - -
  • -

    Add a Transform to this stack. A Transform is a macro that AWS +

    Parameters

    • target: Stack
    • Optional reason: string

    Returns void

addTransform

  • addTransform(transform): 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.

    - -

    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')
-
    -
    -
    -

    Parameters

    -
      -
    • -
      transform: string
      -

      The transform to add

      -
    -

    Returns void

-
-

Protected allocateLogicalId

-

Protected allocateLogicalId

  • allocateLogicalId(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 @@ -412,22 +164,8 @@

    Protected

-
-
-

Parameters

-
    -
  • -
    cfnElement: CfnElement
    -

    The element for which the logical ID is allocated.

    -
-

Returns string

-
-

exportValue

-
    - -
  • -

    Create a CloudFormation Export for a value

    +

    Parameters

    • cfnElement: CfnElement

      The element for which the logical ID is allocated.

      +

    Returns string

exportValue

  • exportValue(exportedValue, options?): string

  • Create a CloudFormation Export for a 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.

    @@ -440,22 +178,14 @@

    exportValue - - -

    Example

    -     -

    Here is how the process works. Let's say there are two stacks, +

    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

    -     -
      +

      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).
        • @@ -464,31 +194,12 @@

        Deployment 1: break 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

      -       -
        +

        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.

    +

    Parameters

    • exportedValue: any
    • Optional options: ExportValueOptions

    Returns string

formatArn

-
-

getLogicalId

-
    - -
  • -

    Allocates a stack-unique CloudFormation-compatible logical identity for a +

    Parameters

    • components: ArnComponents

    Returns string

getLogicalId

-
-

regionalFact

-
    - -
  • -

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

    +

Returns string

regionalFact

-
-

renameLogicalId

-
    - -
  • -

    Rename a generated logical identities

    +

    Parameters

    • factName: string
    • Optional defaultValue: string

    Returns string

renameLogicalId

  • renameLogicalId(oldId, newId): 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

-
-

reportMissingContextKey

-
    - -
  • -

    Indicate that a context key was expected

    +

    Parameters

    • oldId: string
    • newId: string

    Returns void

reportMissingContextKey

  • reportMissingContextKey(report): 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

-
-

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. +

    Parameters

    • report: MissingContext

      The set of parameters needed to obtain the context

      +

    Returns void

resolve

  • resolve(obj): any

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

    +

    Parameters

    • obj: any

    Returns any

splitArn

  • splitArn(arn, 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

-
-

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.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStack

-
    - -
  • -

    Return whether the given object is a Stack.

    +

    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

  • toJsonString(obj, space?): string

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

    +

    Parameters

    • obj: any
    • Optional space: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStack

  • isStack(x): 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

-
-

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

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • x: any

Returns x is Stack

Static of

  • of(construct): 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/SsoPermissionStack.html b/docs/classes/SsoPermissionStack.html index 0494bba..53282fe 100644 --- a/docs/classes/SsoPermissionStack.html +++ b/docs/classes/SsoPermissionStack.html @@ -1,121 +1,44 @@ -SsoPermissionStack | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class SsoPermissionStack<T, S>

-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-

Hierarchy

-
    -
  • Stack -
      -
    • SsoPermissionStack
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account -artifactId -environment -nestedStackResource? -node -permissionSets -region -synthesizer -tags -templateFile -templateOptions -terminationProtection? -
-
-

Accessors

-
availabilityZones -bundlingRequired -dependencies -maxResources -nested -nestedStackParent -notificationArns -partition -stackId -stackName -urlSuffix -
-
-

Methods

-
addDependency -addTransform -allocateLogicalId -exportValue -formatArn -getLogicalId -regionalFact -renameLogicalId -reportMissingContextKey -resolve -splitArn -toJsonString -toString -isConstruct -isStack -of -
-
-

Constructors

-
-

constructor

-
-
-

Properties

-
-

Readonly account

-
account: string
-

The AWS account into which this stack will be deployed.

+SsoPermissionStack | @taimos/cdk-controltower

Class SsoPermissionStack<T, S>

Type Parameters

  • T extends string

  • S extends string

Hierarchy

  • Stack
    • SsoPermissionStack

Constructors

constructor +

Properties

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

Accessors

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

Methods

addDependency +addTransform +allocateLogicalId +exportValue +formatArn +getLogicalId +regionalFact +renameLogicalId +reportMissingContextKey +resolve +splitArn +toJsonString +toString +isConstruct +isStack +of +

Constructors

constructor

Properties

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 @@ -132,18 +55,8 @@

    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 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 +

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 @@ -152,35 +65,11 @@

ReadonlyAws.account 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 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.

- -

Stability

stable

-
-
-

Private permissionSets

-
permissionSets: {
    [name: string]: sso.CfnPermissionSet;
} = {}
-
-

Type declaration

-
    -
  • -
    [name: string]: sso.CfnPermissionSet
-
-

Readonly region

-
region: string
-

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

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

Private permissionSets

permissionSets: {
    [name: string]: sso.CfnPermissionSet;
} = {}

Type declaration

  • [name: string]: sso.CfnPermissionSet

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 @@ -197,48 +86,14 @@

    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 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 +

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 +

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 @@ -248,91 +103,18 @@

    availabilityZonesReturns 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

    +

    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

-
-

stackId

-
    -
  • get stackId(): string
    • -
  • -

    The ID of the stack

    - -

    Example

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

    Returns string

-
-

stackName

-
    -
  • get stackName(): string
    • -
  • -

    The concrete CloudFormation physical stack name.

    +

    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

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

-
-

urlSuffix

-
    -
  • get urlSuffix(): string
    • -
  • -

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

    -
    -

    Returns string

-
-

Methods

-
-

addDependency

-
    - -
  • -

    Add a dependency between this stack and another stack.

    +

    Returns string

urlSuffix

  • get urlSuffix(): string

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

    +

    Returns string

Methods

addDependency

  • addDependency(target, reason?): 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

-
-

addTransform

-
    - -
  • -

    Add a Transform to this stack. A Transform is a macro that AWS +

    Parameters

    • target: Stack
    • Optional reason: string

    Returns void

addTransform

  • addTransform(transform): 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.

    - -

    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')
-
    -
    -
    -

    Parameters

    -
      -
    • -
      transform: string
      -

      The transform to add

      -
    -

    Returns void

-
-

Protected allocateLogicalId

-

Protected allocateLogicalId

  • allocateLogicalId(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 @@ -431,22 +164,8 @@

    Protected

-
-
-

Parameters

-
    -
  • -
    cfnElement: CfnElement
    -

    The element for which the logical ID is allocated.

    -
-

Returns string

-
-

exportValue

-
    - -
  • -

    Create a CloudFormation Export for a value

    +

    Parameters

    • cfnElement: CfnElement

      The element for which the logical ID is allocated.

      +

    Returns string

exportValue

  • exportValue(exportedValue, options?): string

  • Create a CloudFormation Export for a 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.

    @@ -459,22 +178,14 @@

    exportValue - - -

    Example

    -     -

    Here is how the process works. Let's say there are two stacks, +

    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

    -     -
      +

      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).
        • @@ -483,31 +194,12 @@

        Deployment 1: break 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

      -       -
        +

        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.

    +

    Parameters

    • exportedValue: any
    • Optional options: ExportValueOptions

    Returns string

formatArn

-
-

getLogicalId

-
    - -
  • -

    Allocates a stack-unique CloudFormation-compatible logical identity for a +

    Parameters

    • components: ArnComponents

    Returns string

getLogicalId

-
-

regionalFact

-
    - -
  • -

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

    +

Returns string

regionalFact

-
-

renameLogicalId

-
    - -
  • -

    Rename a generated logical identities

    +

    Parameters

    • factName: string
    • Optional defaultValue: string

    Returns string

renameLogicalId

  • renameLogicalId(oldId, newId): 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

-
-

reportMissingContextKey

-
    - -
  • -

    Indicate that a context key was expected

    +

    Parameters

    • oldId: string
    • newId: string

    Returns void

reportMissingContextKey

  • reportMissingContextKey(report): 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

-
-

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. +

    Parameters

    • report: MissingContext

      The set of parameters needed to obtain the context

      +

    Returns void

resolve

  • resolve(obj): any

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

    +

    Parameters

    • obj: any

    Returns any

splitArn

  • splitArn(arn, 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

-
-

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.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStack

-
    - -
  • -

    Return whether the given object is a Stack.

    +

    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

  • toJsonString(obj, space?): string

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

    +

    Parameters

    • obj: any
    • Optional space: number

    Returns string

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStack

  • isStack(x): 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

-
-

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

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • x: any

Returns x is Stack

Static of

  • of(construct): 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/SsoStage.html b/docs/classes/SsoStage.html index 01c6675..bc660e0 100644 --- a/docs/classes/SsoStage.html +++ b/docs/classes/SsoStage.html @@ -1,271 +1,40 @@ -SsoStage | @taimos/cdk-controltower
-
- -
-
-
-
- -

Class SsoStage<T, S>

-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-

Hierarchy

-
    -
  • Stage -
      -
    • SsoStage
-
-
-
- -
-
-

Constructors

-
constructor -
-
-

Properties

-
account? -node -parentStage? -region? -stageName -
-
-

Accessors

-
artifactId -assetOutdir -outdir -
-
-

Methods

-
synth -toString -isConstruct -isStage -of -
-
-

Constructors

-
-

constructor

-
    - -
  • -
    -

    Type Parameters

    -
      -
    • -

      T extends string

      • -
    • -

      S extends string

    -
    -

    Parameters

    -
    -

    Returns SsoStage<T, S>

-
-

Properties

-
-

Optional Readonly account

-
account?: string
-

The default account for all resources defined within this stage.

-
-
-

Readonly node

-
node: Node
-

The tree node.

- -

Stability

stable

-
-
-

Optional Readonly parentStage

-
parentStage?: Stage
-

The parent stage or undefined if this is the app. +SsoStage | @taimos/cdk-controltower

Class SsoStage<T, S>

Type Parameters

  • T extends string

  • S extends string

Hierarchy

  • Stage
    • SsoStage

Constructors

constructor +

Properties

account? +node +parentStage? +region? +stageName +

Accessors

artifactId +assetOutdir +outdir +

Methods

synth +toString +isConstruct +isStage +of +

Constructors

constructor

  • new SsoStage<T, S>(scope, props): SsoStage<T, S>

  • Type Parameters

    • T extends string

    • S extends string

    Parameters

    Returns SsoStage<T, S>

Properties

Optional Readonly account

account?: string

The default account for all resources defined within this stage.

+

Readonly node

node: Node

The tree node.

+

Stability

stable

+

Optional Readonly parentStage

parentStage?: Stage

The parent stage or undefined if this is the app. *

-
-
-

Optional Readonly region

-
region?: string
-

The default region for all resources defined within this stage.

-
-
-

Readonly stageName

-
stageName: string
-

The name of the stage. Based on names of the parent stages separated by +

Optional Readonly region

region?: string

The default region for all resources defined within this stage.

+

Readonly stageName

stageName: string

The name of the stage. Based on names of the parent stages separated by hypens.

-
-
-

Accessors

-
-

artifactId

-
    -
  • get artifactId(): string
    • -
  • -

    Artifact ID of the assembly if it is a nested stage. The root stage (app) +

Accessors

artifactId

  • get artifactId(): string

  • Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.

    Derived from the construct path.

    -
    -

    Returns string

-
-

assetOutdir

-
    -
  • get assetOutdir(): string
    • -
  • -

    The cloud assembly asset output directory.

    -
    -

    Returns string

-
-

outdir

-
    -
  • get outdir(): string
    • -
  • -

    The cloud assembly output directory.

    -
    -

    Returns string

-
-

Methods

-
-

synth

-
    - -
  • -

    Synthesize this stage into a cloud assembly.

    +

    Returns string

assetOutdir

  • get assetOutdir(): string

  • The cloud assembly asset output directory.

    +

    Returns string

outdir

  • get outdir(): string

  • The cloud assembly output directory.

    +

    Returns string

Methods

synth

  • synth(options?): CloudAssembly

  • Synthesize this stage into a cloud assembly.

    Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.

    -
    -
    -

    Parameters

    -
      -
    • -
      Optional options: StageSynthesisOptions
    -

    Returns CloudAssembly

-
-

toString

-
    - -
  • -

    Returns a string representation of this construct.

    - -

    Stability

    stable

    -
    -

    Returns string

-
-

Static isConstruct

-
    - -
  • -

    (deprecated) Checks if x is a construct.

    - -

    Returns

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

    - -

    Deprecated

    use x instanceof Construct instead

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
      -

      Any object.

      -
    -

    Returns x is Construct

-
-

Static isStage

-
    - -
  • -

    Test whether the given construct is a stage.

    -
    -
    -

    Parameters

    -
      -
    • -
      x: any
    -

    Returns x is Stage

-
-

Static of

-
    - -
  • -

    Return the stage this construct is contained with, if available. If called +

    Parameters

    • Optional options: StageSynthesisOptions

    Returns CloudAssembly

toString

  • toString(): string

  • Returns a string representation of this construct.

    +

    Returns string

    Stability

    stable

    +

Static isConstruct

  • isConstruct(x): x is Construct

  • (deprecated) Checks if x is a construct.

    +

    Parameters

    • x: any

      Any object.

      +

    Returns x is Construct

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

    +

    Deprecated

    use x instanceof Construct instead

    +

Static isStage

  • isStage(x): x is Stage

  • Test whether the given construct is a stage.

    +

    Parameters

    • x: any

    Returns x is Stage

Static of

  • of(construct): undefined | Stage

  • Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent.

    -
    -
    -

    Parameters

    -
      -
    • -
      construct: IConstruct
    -

    Returns undefined | Stage

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Parameters

  • construct: IConstruct

Returns undefined | Stage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/generateAccountFile.html b/docs/functions/generateAccountFile.html index 8e60543..08c2bde 100644 --- a/docs/functions/generateAccountFile.html +++ b/docs/functions/generateAccountFile.html @@ -1,84 +1 @@ -generateAccountFile | @taimos/cdk-controltower
-
- -
-
-
-
- -

Function generateAccountFile

-
-
    - -
  • -

    Returns Promise<string>

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +generateAccountFile | @taimos/cdk-controltower

Function generateAccountFile

  • generateAccountFile(): Promise<string>

  • Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/generateSsoConfigFile.html b/docs/functions/generateSsoConfigFile.html index e0bcda6..2a7816f 100644 --- a/docs/functions/generateSsoConfigFile.html +++ b/docs/functions/generateSsoConfigFile.html @@ -1,84 +1 @@ -generateSsoConfigFile | @taimos/cdk-controltower
-
- -
-
-
-
- -

Function generateSsoConfigFile

-
-
    - -
  • -

    Returns Promise<string>

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +generateSsoConfigFile | @taimos/cdk-controltower

Function generateSsoConfigFile

  • generateSsoConfigFile(): Promise<string>

  • Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html new file mode 100644 index 0000000..b8a6d7c --- /dev/null +++ b/docs/hierarchy.html @@ -0,0 +1 @@ +@taimos/cdk-controltower

@taimos/cdk-controltower

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 1eb15b1..e46f183 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,28 +1,6 @@ -@taimos/cdk-controltower
-
- -
-
-
-
-

@taimos/cdk-controltower

-
- -

CDK ControlTower

- -

npm version

+@taimos/cdk-controltower

@taimos/cdk-controltower

CDK ControlTower

npm version

CDK ControlTower is a tool suite to facilitate the use of the AWS Cloud Development Kit (CDK) for AWS Account management and Landing Zone setup. It provides project management features to configure your TypeScript CDK app and also higher-level (L3) constructs for different APIs and resources needed for account management.

- - -

Features

- -
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Authors

Brought to you by Taimos

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountBudgetOptions.html b/docs/interfaces/AccountBudgetOptions.html index 84cc9d4..569aedd 100644 --- a/docs/interfaces/AccountBudgetOptions.html +++ b/docs/interfaces/AccountBudgetOptions.html @@ -1,69 +1,3 @@ -AccountBudgetOptions | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface AccountBudgetOptions

-
-

Hierarchy

-
    -
  • AccountBudgetOptions
-
-
-
- -
-
-

Properties

-
amount -email? -
-
-

Properties

-
-

Readonly amount

-
amount: number
-
-

Optional Readonly email

-
email?: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AccountBudgetOptions | @taimos/cdk-controltower

Interface AccountBudgetOptions

interface AccountBudgetOptions {
    amount: number;
    email?: string;
}

Properties

amount +email? +

Properties

Readonly amount

amount: number

Optional Readonly email

email?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/AccountInfo.html b/docs/interfaces/AccountInfo.html index 5ca13f4..c134b41 100644 --- a/docs/interfaces/AccountInfo.html +++ b/docs/interfaces/AccountInfo.html @@ -1,94 +1,8 @@ -AccountInfo | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface AccountInfo

-
-

Hierarchy

-
    -
  • AccountInfo
-
-
-
- -
-
-

Properties

-
Arn -Email -Id -JoinedMethod -JoinedTimestamp -Name -Status -
-
-

Properties

-
-

Readonly Arn

-
Arn: string
-
-

Readonly Email

-
Email: string
-
-

Readonly Id

-
Id: string
-
-

Readonly JoinedMethod

-
JoinedMethod: string
-
-

Readonly JoinedTimestamp

-
JoinedTimestamp: string
-
-

Readonly Name

-
Name: string
-
-

Readonly Status

-
Status: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AccountInfo | @taimos/cdk-controltower

Interface AccountInfo

interface AccountInfo {
    Arn: string;
    Email: string;
    Id: string;
    JoinedMethod: string;
    JoinedTimestamp: string;
    Name: string;
    Status: string;
}

Properties

Arn +Email +Id +JoinedMethod +JoinedTimestamp +Name +Status +

Properties

Readonly Arn

Arn: string

Readonly Email

Email: string

Readonly Id

Id: string

Readonly JoinedMethod

JoinedMethod: string

Readonly JoinedTimestamp

JoinedTimestamp: string

Readonly Name

Name: string

Readonly Status

Status: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BillingStageConfig.html b/docs/interfaces/BillingStageConfig.html index 7c5835b..cecf853 100644 --- a/docs/interfaces/BillingStageConfig.html +++ b/docs/interfaces/BillingStageConfig.html @@ -1,74 +1,3 @@ -BillingStageConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface BillingStageConfig<T>

-
-

Type Parameters

-
    -
  • -

    T extends string

-
-

Hierarchy

-
    -
  • BillingStageConfig
-
-
-
- -
-
-

Properties

-
budgetConfig? -costReportConfig? -
-
-

Properties

-
-

Optional budgetConfig

-
budgetConfig?: BudgetConfig<T>
-
-

Optional costReportConfig

-
costReportConfig?: CostReportingConfig
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +BillingStageConfig | @taimos/cdk-controltower

Interface BillingStageConfig<T>

interface BillingStageConfig<T> {
    budgetConfig?: BudgetConfig<T>;
    costReportConfig?: CostReportingConfig;
}

Type Parameters

  • T extends string

Properties

budgetConfig? +costReportConfig? +

Properties

Optional budgetConfig

budgetConfig?: BudgetConfig<T>

Optional costReportConfig

costReportConfig?: CostReportingConfig

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/BudgetConfig.html b/docs/interfaces/BudgetConfig.html index bae4fb8..afe6587 100644 --- a/docs/interfaces/BudgetConfig.html +++ b/docs/interfaces/BudgetConfig.html @@ -1,69 +1,2 @@ -BudgetConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface BudgetConfig<T>

-
-

Type Parameters

-
    -
  • -

    T extends string

-
-

Hierarchy

-
    -
  • BudgetConfig
-
-
-
- -
-
-

Properties

-
budgets -
-
-

Properties

-
-

Readonly budgets

-
budgets: AccountConfig<T, number | AccountBudgetOptions>
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +BudgetConfig | @taimos/cdk-controltower

Interface BudgetConfig<T>

interface BudgetConfig<T> {
    budgets: AccountConfig<T, number | AccountBudgetOptions>;
}

Type Parameters

  • T extends string

Properties

budgets +

Properties

Readonly budgets

budgets: AccountConfig<T, number | AccountBudgetOptions>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/ControlTowerProps.html b/docs/interfaces/ControlTowerProps.html index 315ed19..581180b 100644 --- a/docs/interfaces/ControlTowerProps.html +++ b/docs/interfaces/ControlTowerProps.html @@ -1,78 +1,5 @@ -ControlTowerProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface ControlTowerProps<T>

-
-

Properties of a cdk-controltower stack stack

-
-
-

Type Parameters

-
    -
  • -

    T extends string

    -

    the AccountName type of the generated account list

    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
accounts -
-
-

Properties

-
-

Readonly accounts

-
accounts: AccountList<T>
-

The list of AWS accounts. Can be generated by running npx fetch-accounts

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +ControlTowerProps | @taimos/cdk-controltower

Interface ControlTowerProps<T>

Properties of a cdk-controltower stack stack

+
interface ControlTowerProps<T> {
    accounts: AccountList<T>;
}

Type Parameters

  • T extends string

    the AccountName type of the generated account list

    +

Hierarchy (view full)

Properties

accounts +

Properties

Readonly accounts

accounts: AccountList<T>

The list of AWS accounts. Can be generated by running npx fetch-accounts

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/CostReportingConfig.html b/docs/interfaces/CostReportingConfig.html index 35866b6..13a08b0 100644 --- a/docs/interfaces/CostReportingConfig.html +++ b/docs/interfaces/CostReportingConfig.html @@ -1,77 +1,7 @@ -CostReportingConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface CostReportingConfig

-
-

Hierarchy

-
    -
  • CostReportingConfig
-
-
-
- -
-
-

Properties

-
costReportBucketName? -costReportName? -
-
-

Properties

-
-

Optional Readonly costReportBucketName

-
costReportBucketName?: string
-

Name of the Cost and Usage report S3 bucket

- -

Default

${orgPrincipalAccount}-costreport

-
-
-

Optional Readonly costReportName

-
costReportName?: string
-

Name of the Cost and Usage report

- -

Default

default-cur

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +CostReportingConfig | @taimos/cdk-controltower

Interface CostReportingConfig

interface CostReportingConfig {
    costReportBucketName?: string;
    costReportName?: string;
}

Properties

costReportBucketName? +costReportName? +

Properties

Optional Readonly costReportBucketName

costReportBucketName?: string

Name of the Cost and Usage report S3 bucket

+

Default

${orgPrincipalAccount}-costreport

+

Optional Readonly costReportName

costReportName?: string

Name of the Cost and Usage report

+

Default

default-cur

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/GroupInfo.html b/docs/interfaces/GroupInfo.html index 7abbcf4..fdbc21a 100644 --- a/docs/interfaces/GroupInfo.html +++ b/docs/interfaces/GroupInfo.html @@ -1,79 +1,5 @@ -GroupInfo | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface GroupInfo

-
-

Hierarchy

-
    -
  • GroupInfo
-
-
-
- -
-
-

Properties

-
Description? -DisplayName -ExternalIds? -GroupId -
-
-

Properties

-
-

Optional Readonly Description

-
Description?: string
-
-

Readonly DisplayName

-
DisplayName: string
-
-

Optional Readonly ExternalIds

-
ExternalIds?: {
    Id: string;
    Issuer: string;
}[]
-
-

Readonly GroupId

-
GroupId: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +GroupInfo | @taimos/cdk-controltower

Interface GroupInfo

interface GroupInfo {
    Description?: string;
    DisplayName: string;
    ExternalIds?: {
        Id: string;
        Issuer: string;
    }[];
    GroupId: string;
}

Properties

Description? +DisplayName +ExternalIds? +GroupId +

Properties

Optional Readonly Description

Description?: string

Readonly DisplayName

DisplayName: string

Optional Readonly ExternalIds

ExternalIds?: {
    Id: string;
    Issuer: string;
}[]

Type declaration

  • Id: string
  • Issuer: string

Readonly GroupId

GroupId: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/LogArchiveConfig.html b/docs/interfaces/LogArchiveConfig.html index d0a044b..a3448fb 100644 --- a/docs/interfaces/LogArchiveConfig.html +++ b/docs/interfaces/LogArchiveConfig.html @@ -1,64 +1,2 @@ -LogArchiveConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface LogArchiveConfig

-
-

Hierarchy

-
    -
  • LogArchiveConfig
-
-
-
- -
-
-

Properties

-
logArchiveAccount -
-
-

Properties

-
-

Readonly logArchiveAccount

-
logArchiveAccount: AccountInfo
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +LogArchiveConfig | @taimos/cdk-controltower

Interface LogArchiveConfig

interface LogArchiveConfig {
    logArchiveAccount: AccountInfo;
}

Properties

logArchiveAccount +

Properties

Readonly logArchiveAccount

logArchiveAccount: AccountInfo

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/OrgPrincipalAware.html b/docs/interfaces/OrgPrincipalAware.html index d0ae864..51813d9 100644 --- a/docs/interfaces/OrgPrincipalAware.html +++ b/docs/interfaces/OrgPrincipalAware.html @@ -1,66 +1,3 @@ -OrgPrincipalAware | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface OrgPrincipalAware

-
-

Hierarchy

-
    -
  • OrgPrincipalAware
-
-
-
- -
-
-

Properties

-
orgPrincipalEnv -
-
-

Properties

-
-

Readonly orgPrincipalEnv

-
orgPrincipalEnv: Environment
-

The organization principal account

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +OrgPrincipalAware | @taimos/cdk-controltower

Interface OrgPrincipalAware

interface OrgPrincipalAware {
    orgPrincipalEnv: Environment;
}

Properties

orgPrincipalEnv +

Properties

Readonly orgPrincipalEnv

orgPrincipalEnv: Environment

The organization principal account

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/PermissionSetOptions.html b/docs/interfaces/PermissionSetOptions.html index 831f05d..7b5e677 100644 --- a/docs/interfaces/PermissionSetOptions.html +++ b/docs/interfaces/PermissionSetOptions.html @@ -1,104 +1,16 @@ -PermissionSetOptions | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface PermissionSetOptions

-
-

Hierarchy

-
    -
  • PermissionSetOptions
-
-
-
- -
-
-

Properties

-
description? -inlinePolicy? -managedPolicies? -relayStateType? -sessionDuration? -
-
-

Properties

-
-

Optional Readonly description

-
description?: string
-

The description of the PermissionSet .

- -

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-description

-
-
-

Optional Readonly inlinePolicy

-
inlinePolicy?: any
-

The IAM inline policy that is attached to the permission set.

- -

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-inlinepolicy

-
-
-

Optional Readonly managedPolicies

-
managedPolicies?: string[]
-

A structure that stores the details of the IAM managed policy.

- -

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-managedpolicies

-
-
-

Optional Readonly relayStateType

-
relayStateType?: string
-

Used to redirect users within the application during the federation authentication process.

- -

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype

-
-
-

Optional Readonly sessionDuration

-
sessionDuration?: string
-

The length of time that the application user sessions are valid for in the ISO-8601 standard.

- -

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +PermissionSetOptions | @taimos/cdk-controltower

Interface PermissionSetOptions

interface PermissionSetOptions {
    description?: string;
    inlinePolicy?: any;
    managedPolicies?: string[];
    relayStateType?: string;
    sessionDuration?: string;
}

Properties

description? +inlinePolicy? +managedPolicies? +relayStateType? +sessionDuration? +

Properties

Optional Readonly description

description?: string

The description of the PermissionSet .

+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-description

+

Optional Readonly inlinePolicy

inlinePolicy?: any

The IAM inline policy that is attached to the permission set.

+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-inlinepolicy

+

Optional Readonly managedPolicies

managedPolicies?: string[]

A structure that stores the details of the IAM managed policy.

+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-managedpolicies

+

Optional Readonly relayStateType

relayStateType?: string

Used to redirect users within the application during the federation authentication process.

+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-relaystatetype

+

Optional Readonly sessionDuration

sessionDuration?: string

The length of time that the application user sessions are valid for in the ISO-8601 standard.

+

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-sso-permissionset.html#cfn-sso-permissionset-sessionduration

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SsoConfig.html b/docs/interfaces/SsoConfig.html index a5f34bb..558aab6 100644 --- a/docs/interfaces/SsoConfig.html +++ b/docs/interfaces/SsoConfig.html @@ -1,79 +1,4 @@ -SsoConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface SsoConfig<T>

-
-

Type Parameters

-
    -
  • -

    T extends string

-
-

Hierarchy

-
    -
  • SsoConfig
-
-
-
- -
-
-

Properties

-
groups -identityStoreId -instanceArn -
-
-

Properties

-
-

Readonly groups

-
groups: GroupList<T>
-
-

Readonly identityStoreId

-
identityStoreId: string
-
-

Readonly instanceArn

-
instanceArn: string
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +SsoConfig | @taimos/cdk-controltower

Interface SsoConfig<T>

interface SsoConfig<T> {
    groups: GroupList<T>;
    identityStoreId: string;
    instanceArn: string;
}

Type Parameters

  • T extends string

Properties

groups +identityStoreId +instanceArn +

Properties

Readonly groups

groups: GroupList<T>

Readonly identityStoreId

identityStoreId: string

Readonly instanceArn

instanceArn: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SsoPermissionConfig.html b/docs/interfaces/SsoPermissionConfig.html index 2fe3d06..225717e 100644 --- a/docs/interfaces/SsoPermissionConfig.html +++ b/docs/interfaces/SsoPermissionConfig.html @@ -1,118 +1,16 @@ -SsoPermissionConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface SsoPermissionConfig<T, S>

-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-

Hierarchy

-
    -
  • SsoPermissionConfig
-
-
-
- -
-
-

Properties

-
adminSetOptions? -billingSetOptions? -defaultAssignmentsForNewAccount? -groupPermissions -permissionSets? -readOnlySetOptions? -
-
-

Properties

-
-

Optional Readonly adminSetOptions

-
adminSetOptions?: PermissionSetOptions
-

optional configuration options for the Admin permission set

- -

Default

AdministratorAccess with 8 hours session duration

-
-
-

Optional Readonly billingSetOptions

-
billingSetOptions?: PermissionSetOptions
-

optional configuration options for the Admin permission set

- -

Default

ReadOnlyAccess and job-function/Billing with 8 hours session duration

-
-
-

Optional Readonly defaultAssignmentsForNewAccount

-
defaultAssignmentsForNewAccount?: {
    groupName: S;
    permissionSetName: string;
}[]
-

Collection of group - permission set assignments for every new account

+SsoPermissionConfig | @taimos/cdk-controltower

Interface SsoPermissionConfig<T, S>

interface SsoPermissionConfig<T, S> {
    adminSetOptions?: PermissionSetOptions;
    billingSetOptions?: PermissionSetOptions;
    defaultAssignmentsForNewAccount?: {
        groupName: S;
        permissionSetName: string;
    }[];
    groupPermissions: AccountConfig<T, GroupConfig<S, string[]>>;
    permissionSets?: {
        [name: string]: PermissionSetOptions;
    };
    readOnlySetOptions?: PermissionSetOptions;
}

Type Parameters

  • T extends string

  • S extends string

Properties

adminSetOptions? +billingSetOptions? +defaultAssignmentsForNewAccount? +groupPermissions +permissionSets? +readOnlySetOptions? +

Properties

Optional Readonly adminSetOptions

adminSetOptions?: PermissionSetOptions

optional configuration options for the Admin permission set

+

Default

AdministratorAccess with 8 hours session duration

+

Optional Readonly billingSetOptions

billingSetOptions?: PermissionSetOptions

optional configuration options for the Admin permission set

+

Default

ReadOnlyAccess and job-function/Billing with 8 hours session duration

+

Optional Readonly defaultAssignmentsForNewAccount

defaultAssignmentsForNewAccount?: {
    groupName: S;
    permissionSetName: string;
}[]

Collection of group - permission set assignments for every new account

Use this to grant your admins permissions for every account directly after creation

-
-
-

Readonly groupPermissions

-
groupPermissions: AccountConfig<T, GroupConfig<S, string[]>>
-
-

Optional Readonly permissionSets

-
permissionSets?: {
    [name: string]: PermissionSetOptions;
}
-

add more permission sets here besides Admin, Billing, and ReadOnly

-
-
-

Type declaration

-
-
-

Optional Readonly readOnlySetOptions

-
readOnlySetOptions?: PermissionSetOptions
-

optional configuration options for the ReadOnly permission set

- -

Default

ReadOnlyAccess with 8 hours session duration

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Type declaration

  • Readonly groupName: S
  • Readonly permissionSetName: string

Readonly groupPermissions

groupPermissions: AccountConfig<T, GroupConfig<S, string[]>>

Optional Readonly permissionSets

permissionSets?: {
    [name: string]: PermissionSetOptions;
}

add more permission sets here besides Admin, Billing, and ReadOnly

+

Type declaration

Optional Readonly readOnlySetOptions

readOnlySetOptions?: PermissionSetOptions

optional configuration options for the ReadOnly permission set

+

Default

ReadOnlyAccess with 8 hours session duration

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SsoProps.html b/docs/interfaces/SsoProps.html index 243d784..fb38406 100644 --- a/docs/interfaces/SsoProps.html +++ b/docs/interfaces/SsoProps.html @@ -1,90 +1,8 @@ -SsoProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface SsoProps<T, S>

-
-

Properties of the SSO stack

-
-
-

Type Parameters

-
    -
  • -

    T extends string

    -

    the AccountName type of the generated account list

    -
    • -
  • -

    S extends string

    -

    the GroupName type of the generated sso config

    -
-
-

Hierarchy

-
-
-
-
- -
-
-

Properties

-
accounts -ssoConfig -
-
-

Properties

-
-

Readonly accounts

-
accounts: AccountList<T>
-

The list of AWS accounts. Can be generated by running npx fetch-accounts

-
-
-

Readonly ssoConfig

-
ssoConfig: SsoConfig<S>
-

The configuration of the AWS SSO org. Can be generated by running npx fetch-sso-config

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +SsoProps | @taimos/cdk-controltower

Interface SsoProps<T, S>

Properties of the SSO stack

+
interface SsoProps<T, S> {
    accounts: AccountList<T>;
    ssoConfig: SsoConfig<S>;
}

Type Parameters

  • T extends string

    the AccountName type of the generated account list

    +

  • S extends string

    the GroupName type of the generated sso config

    +

Hierarchy (view full)

Properties

accounts +ssoConfig +

Properties

Readonly accounts

accounts: AccountList<T>

The list of AWS accounts. Can be generated by running npx fetch-accounts

+

Readonly ssoConfig

ssoConfig: SsoConfig<S>

The configuration of the AWS SSO org. Can be generated by running npx fetch-sso-config

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/SsoStageConfig.html b/docs/interfaces/SsoStageConfig.html index bf1be7c..00a1535 100644 --- a/docs/interfaces/SsoStageConfig.html +++ b/docs/interfaces/SsoStageConfig.html @@ -1,71 +1,2 @@ -SsoStageConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Interface SsoStageConfig<T, S>

-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-

Hierarchy

-
    -
  • SsoStageConfig
-
-
-
- -
-
-

Properties

-
permissionsConfiguration? -
-
-

Properties

-
-

Optional permissionsConfiguration

-
permissionsConfiguration?: SsoPermissionConfig<T, S>
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +SsoStageConfig | @taimos/cdk-controltower

Interface SsoStageConfig<T, S>

interface SsoStageConfig<T, S> {
    permissionsConfiguration?: SsoPermissionConfig<T, S>;
}

Type Parameters

  • T extends string

  • S extends string

Properties

permissionsConfiguration? +

Properties

Optional permissionsConfiguration

permissionsConfiguration?: SsoPermissionConfig<T, S>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index 2e19268..bbe8af5 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,127 +1,37 @@ -@taimos/cdk-controltower
-
- -
-
-
-
-

@taimos/cdk-controltower

-
-
-

Index

-
-

Classes

-
BillingStage -BudgetStack -ControlTowerPipeline -CostReportingStack -LogArchiveStage -LogBucketStack -SsoPermissionStack -SsoStage -
-
-

Interfaces

-
AccountBudgetOptions -AccountInfo -BillingStageConfig -BudgetConfig -ControlTowerProps -CostReportingConfig -GroupInfo -LogArchiveConfig -OrgPrincipalAware -PermissionSetOptions -SsoConfig -SsoPermissionConfig -SsoProps -SsoStageConfig -
-
-

Type Aliases

-
AccountConfig -AccountList -BillingStageProps -BudgetStackProps -ControlTowerPipelineProps -CostReportingStackProps -GroupConfig -GroupList -LogArchiveStageProps -LogBucketStackProps -SsoPermissionStackProps -SsoStageProps -
-
-

Functions

-
generateAccountFile -generateSsoConfigFile -
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +@taimos/cdk-controltower

@taimos/cdk-controltower

Index

Classes

BillingStage +BudgetStack +ControlTowerPipeline +CostReportingStack +LogArchiveStage +LogBucketStack +SsoPermissionStack +SsoStage +

Interfaces

AccountBudgetOptions +AccountInfo +BillingStageConfig +BudgetConfig +ControlTowerProps +CostReportingConfig +GroupInfo +LogArchiveConfig +OrgPrincipalAware +PermissionSetOptions +SsoConfig +SsoPermissionConfig +SsoProps +SsoStageConfig +

Type Aliases

AccountConfig +AccountList +BillingStageProps +BudgetStackProps +ControlTowerPipelineProps +CostReportingStackProps +GroupConfig +GroupList +LogArchiveStageProps +LogBucketStackProps +SsoPermissionStackProps +SsoStageProps +

Functions

generateAccountFile +generateSsoConfigFile +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/AccountConfig.html b/docs/types/AccountConfig.html index c7948d9..c08ded9 100644 --- a/docs/types/AccountConfig.html +++ b/docs/types/AccountConfig.html @@ -1,87 +1 @@ -AccountConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias AccountConfig<T, V>

-
AccountConfig<T, V>: { [ name in T]?: V }
-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    V

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AccountConfig | @taimos/cdk-controltower

Type alias AccountConfig<T, V>

AccountConfig<T, V>: {
    [name in T]?: V
}

Type Parameters

  • T extends string

  • V

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/AccountList.html b/docs/types/AccountList.html index 4b4f772..a625c9c 100644 --- a/docs/types/AccountList.html +++ b/docs/types/AccountList.html @@ -1,85 +1 @@ -AccountList | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias AccountList<T>

-
AccountList<T>: { [ name in T]: AccountInfo }
-
-

Type Parameters

-
    -
  • -

    T extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +AccountList | @taimos/cdk-controltower

Type alias AccountList<T>

AccountList<T>: {
    [name in T]: AccountInfo
}

Type Parameters

  • T extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BillingStageProps.html b/docs/types/BillingStageProps.html index 22b4436..93e6d12 100644 --- a/docs/types/BillingStageProps.html +++ b/docs/types/BillingStageProps.html @@ -1,85 +1 @@ -BillingStageProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias BillingStageProps<T>

-
BillingStageProps<T>: BillingStageConfig<T> & StageProps & ControlTowerProps<T> & OrgPrincipalAware
-
-

Type Parameters

-
    -
  • -

    T extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +BillingStageProps | @taimos/cdk-controltower

Type alias BillingStageProps<T>

BillingStageProps<T>: BillingStageConfig<T> & StageProps & ControlTowerProps<T> & OrgPrincipalAware

Type Parameters

  • T extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/BudgetStackProps.html b/docs/types/BudgetStackProps.html index 505b201..e8f6871 100644 --- a/docs/types/BudgetStackProps.html +++ b/docs/types/BudgetStackProps.html @@ -1,85 +1 @@ -BudgetStackProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias BudgetStackProps<T>

-
BudgetStackProps<T>: BudgetConfig<T> & StackProps & ControlTowerProps<T>
-
-

Type Parameters

-
    -
  • -

    T extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +BudgetStackProps | @taimos/cdk-controltower

Type alias BudgetStackProps<T>

BudgetStackProps<T>: BudgetConfig<T> & StackProps & ControlTowerProps<T>

Type Parameters

  • T extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/ControlTowerPipelineProps.html b/docs/types/ControlTowerPipelineProps.html index 230a55a..4471ed1 100644 --- a/docs/types/ControlTowerPipelineProps.html +++ b/docs/types/ControlTowerPipelineProps.html @@ -1,87 +1 @@ -ControlTowerPipelineProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias ControlTowerPipelineProps<T, S>

-
ControlTowerPipelineProps<T, S>: SsoProps<T, S> & OrgPrincipalAware & StackProps
-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +ControlTowerPipelineProps | @taimos/cdk-controltower

Type alias ControlTowerPipelineProps<T, S>

ControlTowerPipelineProps<T, S>: SsoProps<T, S> & OrgPrincipalAware & StackProps

Type Parameters

  • T extends string

  • S extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/CostReportingStackProps.html b/docs/types/CostReportingStackProps.html index bc61721..365818a 100644 --- a/docs/types/CostReportingStackProps.html +++ b/docs/types/CostReportingStackProps.html @@ -1,80 +1 @@ -CostReportingStackProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias CostReportingStackProps

-
CostReportingStackProps: CostReportingConfig & StackProps & OrgPrincipalAware
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +CostReportingStackProps | @taimos/cdk-controltower

Type alias CostReportingStackProps

CostReportingStackProps: CostReportingConfig & StackProps & OrgPrincipalAware

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/GroupConfig.html b/docs/types/GroupConfig.html index 761d908..edd7235 100644 --- a/docs/types/GroupConfig.html +++ b/docs/types/GroupConfig.html @@ -1,87 +1 @@ -GroupConfig | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias GroupConfig<T, V>

-
GroupConfig<T, V>: { [ name in T]?: V }
-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    V

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +GroupConfig | @taimos/cdk-controltower

Type alias GroupConfig<T, V>

GroupConfig<T, V>: {
    [name in T]?: V
}

Type Parameters

  • T extends string

  • V

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/GroupList.html b/docs/types/GroupList.html index 2b8dffd..c691f4b 100644 --- a/docs/types/GroupList.html +++ b/docs/types/GroupList.html @@ -1,85 +1 @@ -GroupList | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias GroupList<T>

-
GroupList<T>: { [ name in T]: GroupInfo }
-
-

Type Parameters

-
    -
  • -

    T extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +GroupList | @taimos/cdk-controltower

Type alias GroupList<T>

GroupList<T>: {
    [name in T]: GroupInfo
}

Type Parameters

  • T extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/LogArchiveStageProps.html b/docs/types/LogArchiveStageProps.html index 8c38bba..b2515f2 100644 --- a/docs/types/LogArchiveStageProps.html +++ b/docs/types/LogArchiveStageProps.html @@ -1,80 +1 @@ -LogArchiveStageProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias LogArchiveStageProps

-
LogArchiveStageProps: OrgPrincipalAware & LogArchiveConfig & StageProps
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +LogArchiveStageProps | @taimos/cdk-controltower

Type alias LogArchiveStageProps

LogArchiveStageProps: OrgPrincipalAware & LogArchiveConfig & StageProps

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/LogBucketStackProps.html b/docs/types/LogBucketStackProps.html index cb770b9..e93b50f 100644 --- a/docs/types/LogBucketStackProps.html +++ b/docs/types/LogBucketStackProps.html @@ -1,80 +1 @@ -LogBucketStackProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias LogBucketStackProps

-
LogBucketStackProps: StackProps & OrgPrincipalAware
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +LogBucketStackProps | @taimos/cdk-controltower

Type alias LogBucketStackProps

LogBucketStackProps: StackProps & OrgPrincipalAware

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/SsoPermissionStackProps.html b/docs/types/SsoPermissionStackProps.html index 5054c58..c08bad7 100644 --- a/docs/types/SsoPermissionStackProps.html +++ b/docs/types/SsoPermissionStackProps.html @@ -1,87 +1 @@ -SsoPermissionStackProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias SsoPermissionStackProps<T, S>

-
SsoPermissionStackProps<T, S>: SsoProps<T, S> & SsoPermissionConfig<T, S> & StackProps
-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +SsoPermissionStackProps | @taimos/cdk-controltower

Type alias SsoPermissionStackProps<T, S>

SsoPermissionStackProps<T, S>: SsoProps<T, S> & SsoPermissionConfig<T, S> & StackProps

Type Parameters

  • T extends string

  • S extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/types/SsoStageProps.html b/docs/types/SsoStageProps.html index 7a1c55a..99c431b 100644 --- a/docs/types/SsoStageProps.html +++ b/docs/types/SsoStageProps.html @@ -1,87 +1 @@ -SsoStageProps | @taimos/cdk-controltower
-
- -
-
-
-
- -

Type alias SsoStageProps<T, S>

-
SsoStageProps<T, S>: SsoStageConfig<T, S> & SsoProps<T, S> & StageProps & OrgPrincipalAware
-
-

Type Parameters

-
    -
  • -

    T extends string

    • -
  • -

    S extends string

-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

- -
-
-

Generated using TypeDoc

-
\ No newline at end of file +SsoStageProps | @taimos/cdk-controltower

Type alias SsoStageProps<T, S>

SsoStageProps<T, S>: SsoStageConfig<T, S> & SsoProps<T, S> & StageProps & OrgPrincipalAware

Type Parameters

  • T extends string

  • S extends string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file