index.html 100 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="../aws-secrets-manager/">
  7. <link rel="next" href="../azure-key-vault/">
  8. <link rel="icon" href="../../pictures/eso-round-logo.svg">
  9. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.44">
  10. <title>AWS Parameter Store - External Secrets Operator</title>
  11. <link rel="stylesheet" href="../../assets/stylesheets/main.0253249f.min.css">
  12. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  17. <script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-QP38TD8K7V"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-QP38TD8K7V",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-QP38TD8K7V",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  18. <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#parameter-store" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <div data-md-color-scheme="default" data-md-component="outdated" hidden>
  32. <aside class="md-banner md-banner--warning">
  33. <div class="md-banner__inner md-grid md-typeset">
  34. You're not viewing the latest version.
  35. <a href="../../..">
  36. <strong>Click here to go to latest.</strong>
  37. </a>
  38. </div>
  39. <script>var el=document.querySelector("[data-md-component=outdated]"),outdated=__md_get("__outdated",sessionStorage);!0===outdated&&el&&(el.hidden=!1)</script>
  40. </aside>
  41. </div>
  42. <header class="md-header" data-md-component="header">
  43. <nav class="md-header__inner md-grid" aria-label="Header">
  44. <a href="../.." title="External Secrets Operator" class="md-header__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  45. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  46. </a>
  47. <label class="md-header__button md-icon" for="__drawer">
  48. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  49. </label>
  50. <div class="md-header__title" data-md-component="header-title">
  51. <div class="md-header__ellipsis">
  52. <div class="md-header__topic">
  53. <span class="md-ellipsis">
  54. External Secrets Operator
  55. </span>
  56. </div>
  57. <div class="md-header__topic" data-md-component="header-topic">
  58. <span class="md-ellipsis">
  59. AWS Parameter Store
  60. </span>
  61. </div>
  62. </div>
  63. </div>
  64. <form class="md-header__option" data-md-component="palette">
  65. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
  66. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
  67. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  68. </label>
  69. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
  70. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
  71. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  72. </label>
  73. </form>
  74. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  75. <label class="md-header__button md-icon" for="__search">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  77. </label>
  78. <div class="md-search" data-md-component="search" role="dialog">
  79. <label class="md-search__overlay" for="__search"></label>
  80. <div class="md-search__inner" role="search">
  81. <form class="md-search__form" name="search">
  82. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  83. <label class="md-search__icon md-icon" for="__search">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  85. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  86. </label>
  87. <nav class="md-search__options" aria-label="Search">
  88. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  89. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  90. </button>
  91. </nav>
  92. </form>
  93. <div class="md-search__output">
  94. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  95. <div class="md-search-result" data-md-component="search-result">
  96. <div class="md-search-result__meta">
  97. Initializing search
  98. </div>
  99. <ol class="md-search-result__list" role="presentation"></ol>
  100. </div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="md-header__source">
  106. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  107. <div class="md-source__icon md-icon">
  108. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  109. </div>
  110. <div class="md-source__repository">
  111. External Secrets Operator
  112. </div>
  113. </a>
  114. </div>
  115. </nav>
  116. </header>
  117. <div class="md-container" data-md-component="container">
  118. <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
  119. <div class="md-grid">
  120. <ul class="md-tabs__list">
  121. <li class="md-tabs__item">
  122. <a href="../.." class="md-tabs__link">
  123. Introduction
  124. </a>
  125. </li>
  126. <li class="md-tabs__item">
  127. <a href="../../api/components/" class="md-tabs__link">
  128. API
  129. </a>
  130. </li>
  131. <li class="md-tabs__item">
  132. <a href="../../guides/introduction/" class="md-tabs__link">
  133. Guides
  134. </a>
  135. </li>
  136. <li class="md-tabs__item md-tabs__item--active">
  137. <a href="../aws-secrets-manager/" class="md-tabs__link">
  138. Provider
  139. </a>
  140. </li>
  141. <li class="md-tabs__item">
  142. <a href="../../examples/gitops-using-fluxcd/" class="md-tabs__link">
  143. Examples
  144. </a>
  145. </li>
  146. <li class="md-tabs__item">
  147. <a href="../../contributing/devguide/" class="md-tabs__link">
  148. Community
  149. </a>
  150. </li>
  151. </ul>
  152. </div>
  153. </nav>
  154. <main class="md-main" data-md-component="main">
  155. <div class="md-main__inner md-grid">
  156. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  157. <div class="md-sidebar__scrollwrap">
  158. <div class="md-sidebar__inner">
  159. <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
  160. <label class="md-nav__title" for="__drawer">
  161. <a href="../.." title="External Secrets Operator" class="md-nav__button md-logo" aria-label="External Secrets Operator" data-md-component="logo">
  162. <img src="../../pictures/eso-round-logo.svg" alt="logo">
  163. </a>
  164. External Secrets Operator
  165. </label>
  166. <div class="md-nav__source">
  167. <a href="https://github.com/external-secrets/external-secrets" title="Go to repository" class="md-source" data-md-component="source">
  168. <div class="md-source__icon md-icon">
  169. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  170. </div>
  171. <div class="md-source__repository">
  172. External Secrets Operator
  173. </div>
  174. </a>
  175. </div>
  176. <ul class="md-nav__list" data-md-scrollfix>
  177. <li class="md-nav__item md-nav__item--nested">
  178. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_1" >
  179. <div class="md-nav__link md-nav__container">
  180. <a href="../.." class="md-nav__link ">
  181. <span class="md-ellipsis">
  182. Introduction
  183. </span>
  184. </a>
  185. <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
  186. <span class="md-nav__icon md-icon"></span>
  187. </label>
  188. </div>
  189. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
  190. <label class="md-nav__title" for="__nav_1">
  191. <span class="md-nav__icon md-icon"></span>
  192. Introduction
  193. </label>
  194. <ul class="md-nav__list" data-md-scrollfix>
  195. <li class="md-nav__item">
  196. <a href="../../introduction/overview/" class="md-nav__link">
  197. <span class="md-ellipsis">
  198. Overview
  199. </span>
  200. </a>
  201. </li>
  202. <li class="md-nav__item">
  203. <a href="../../introduction/getting-started/" class="md-nav__link">
  204. <span class="md-ellipsis">
  205. Getting started
  206. </span>
  207. </a>
  208. </li>
  209. <li class="md-nav__item">
  210. <a href="../../introduction/faq/" class="md-nav__link">
  211. <span class="md-ellipsis">
  212. FAQ
  213. </span>
  214. </a>
  215. </li>
  216. <li class="md-nav__item">
  217. <a href="../../introduction/stability-support/" class="md-nav__link">
  218. <span class="md-ellipsis">
  219. Stability and Support
  220. </span>
  221. </a>
  222. </li>
  223. <li class="md-nav__item">
  224. <a href="../../introduction/deprecation-policy/" class="md-nav__link">
  225. <span class="md-ellipsis">
  226. Deprecation Policy
  227. </span>
  228. </a>
  229. </li>
  230. </ul>
  231. </nav>
  232. </li>
  233. <li class="md-nav__item md-nav__item--nested">
  234. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
  235. <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
  236. <span class="md-ellipsis">
  237. API
  238. </span>
  239. <span class="md-nav__icon md-icon"></span>
  240. </label>
  241. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
  242. <label class="md-nav__title" for="__nav_2">
  243. <span class="md-nav__icon md-icon"></span>
  244. API
  245. </label>
  246. <ul class="md-nav__list" data-md-scrollfix>
  247. <li class="md-nav__item">
  248. <a href="../../api/components/" class="md-nav__link">
  249. <span class="md-ellipsis">
  250. Components
  251. </span>
  252. </a>
  253. </li>
  254. <li class="md-nav__item md-nav__item--nested">
  255. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
  256. <label class="md-nav__link" for="__nav_2_2" id="__nav_2_2_label" tabindex="0">
  257. <span class="md-ellipsis">
  258. Core Resources
  259. </span>
  260. <span class="md-nav__icon md-icon"></span>
  261. </label>
  262. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
  263. <label class="md-nav__title" for="__nav_2_2">
  264. <span class="md-nav__icon md-icon"></span>
  265. Core Resources
  266. </label>
  267. <ul class="md-nav__list" data-md-scrollfix>
  268. <li class="md-nav__item">
  269. <a href="../../api/externalsecret/" class="md-nav__link">
  270. <span class="md-ellipsis">
  271. ExternalSecret
  272. </span>
  273. </a>
  274. </li>
  275. <li class="md-nav__item">
  276. <a href="../../api/secretstore/" class="md-nav__link">
  277. <span class="md-ellipsis">
  278. SecretStore
  279. </span>
  280. </a>
  281. </li>
  282. <li class="md-nav__item">
  283. <a href="../../api/clustersecretstore/" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. ClusterSecretStore
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="../../api/clusterexternalsecret/" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. ClusterExternalSecret
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../api/pushsecret/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. PushSecret
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. <li class="md-nav__item md-nav__item--nested">
  307. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
  308. <div class="md-nav__link md-nav__container">
  309. <a href="../../api/generator/" class="md-nav__link ">
  310. <span class="md-ellipsis">
  311. Generators
  312. </span>
  313. </a>
  314. <label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="0">
  315. <span class="md-nav__icon md-icon"></span>
  316. </label>
  317. </div>
  318. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
  319. <label class="md-nav__title" for="__nav_2_3">
  320. <span class="md-nav__icon md-icon"></span>
  321. Generators
  322. </label>
  323. <ul class="md-nav__list" data-md-scrollfix>
  324. <li class="md-nav__item">
  325. <a href="../../api/generator/acr/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Azure Container Registry
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../api/generator/ecr/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. AWS Elastic Container Registry
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../api/generator/sts/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. AWS STS Session Token
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../api/generator/gcr/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. Google Container Registry
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../api/generator/vault/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. Vault Dynamic Secret
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../api/generator/password/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. Password
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../api/generator/fake/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. Fake
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../api/generator/webhook/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. Webhook
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../api/generator/github/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. Github
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../api/generator/uuid/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. UUID
  391. </span>
  392. </a>
  393. </li>
  394. </ul>
  395. </nav>
  396. </li>
  397. <li class="md-nav__item md-nav__item--nested">
  398. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
  399. <label class="md-nav__link" for="__nav_2_4" id="__nav_2_4_label" tabindex="0">
  400. <span class="md-ellipsis">
  401. Reference Docs
  402. </span>
  403. <span class="md-nav__icon md-icon"></span>
  404. </label>
  405. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
  406. <label class="md-nav__title" for="__nav_2_4">
  407. <span class="md-nav__icon md-icon"></span>
  408. Reference Docs
  409. </label>
  410. <ul class="md-nav__list" data-md-scrollfix>
  411. <li class="md-nav__item">
  412. <a href="../../api/spec/" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. API specification
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../../api/controller-options/" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. Controller Options
  422. </span>
  423. </a>
  424. </li>
  425. <li class="md-nav__item">
  426. <a href="../../api/metrics/" class="md-nav__link">
  427. <span class="md-ellipsis">
  428. Metrics
  429. </span>
  430. </a>
  431. </li>
  432. </ul>
  433. </nav>
  434. </li>
  435. </ul>
  436. </nav>
  437. </li>
  438. <li class="md-nav__item md-nav__item--nested">
  439. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
  440. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  441. <span class="md-ellipsis">
  442. Guides
  443. </span>
  444. <span class="md-nav__icon md-icon"></span>
  445. </label>
  446. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  447. <label class="md-nav__title" for="__nav_3">
  448. <span class="md-nav__icon md-icon"></span>
  449. Guides
  450. </label>
  451. <ul class="md-nav__list" data-md-scrollfix>
  452. <li class="md-nav__item">
  453. <a href="../../guides/introduction/" class="md-nav__link">
  454. <span class="md-ellipsis">
  455. Introduction
  456. </span>
  457. </a>
  458. </li>
  459. <li class="md-nav__item md-nav__item--nested">
  460. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2" >
  461. <label class="md-nav__link" for="__nav_3_2" id="__nav_3_2_label" tabindex="0">
  462. <span class="md-ellipsis">
  463. External Secrets
  464. </span>
  465. <span class="md-nav__icon md-icon"></span>
  466. </label>
  467. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_2_label" aria-expanded="false">
  468. <label class="md-nav__title" for="__nav_3_2">
  469. <span class="md-nav__icon md-icon"></span>
  470. External Secrets
  471. </label>
  472. <ul class="md-nav__list" data-md-scrollfix>
  473. <li class="md-nav__item">
  474. <a href="../../guides/all-keys-one-secret/" class="md-nav__link">
  475. <span class="md-ellipsis">
  476. Extract structured data
  477. </span>
  478. </a>
  479. </li>
  480. <li class="md-nav__item">
  481. <a href="../../guides/getallsecrets/" class="md-nav__link">
  482. <span class="md-ellipsis">
  483. Find Secrets by Name or Metadata
  484. </span>
  485. </a>
  486. </li>
  487. <li class="md-nav__item">
  488. <a href="../../guides/datafrom-rewrite/" class="md-nav__link">
  489. <span class="md-ellipsis">
  490. Rewriting Keys
  491. </span>
  492. </a>
  493. </li>
  494. <li class="md-nav__item md-nav__item--nested">
  495. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_2_4" >
  496. <label class="md-nav__link" for="__nav_3_2_4" id="__nav_3_2_4_label" tabindex="0">
  497. <span class="md-ellipsis">
  498. Advanced Templating
  499. </span>
  500. <span class="md-nav__icon md-icon"></span>
  501. </label>
  502. <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_2_4_label" aria-expanded="false">
  503. <label class="md-nav__title" for="__nav_3_2_4">
  504. <span class="md-nav__icon md-icon"></span>
  505. Advanced Templating
  506. </label>
  507. <ul class="md-nav__list" data-md-scrollfix>
  508. <li class="md-nav__item">
  509. <a href="../../guides/templating/" class="md-nav__link">
  510. <span class="md-ellipsis">
  511. v2
  512. </span>
  513. </a>
  514. </li>
  515. <li class="md-nav__item">
  516. <a href="../../guides/templating-v1/" class="md-nav__link">
  517. <span class="md-ellipsis">
  518. v1
  519. </span>
  520. </a>
  521. </li>
  522. </ul>
  523. </nav>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../../guides/common-k8s-secret-types/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. Kubernetes Secret Types
  529. </span>
  530. </a>
  531. </li>
  532. <li class="md-nav__item">
  533. <a href="../../guides/ownership-deletion-policy/" class="md-nav__link">
  534. <span class="md-ellipsis">
  535. Lifecycle: ownership & deletion
  536. </span>
  537. </a>
  538. </li>
  539. <li class="md-nav__item">
  540. <a href="../../guides/decoding-strategy/" class="md-nav__link">
  541. <span class="md-ellipsis">
  542. Decoding Strategies
  543. </span>
  544. </a>
  545. </li>
  546. <li class="md-nav__item">
  547. <a href="../../guides/controller-class/" class="md-nav__link">
  548. <span class="md-ellipsis">
  549. Controller Classes
  550. </span>
  551. </a>
  552. </li>
  553. </ul>
  554. </nav>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../../guides/generator/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Generators
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../../guides/pushsecrets/" class="md-nav__link">
  565. <span class="md-ellipsis">
  566. Push Secrets
  567. </span>
  568. </a>
  569. </li>
  570. <li class="md-nav__item md-nav__item--nested">
  571. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3_5" >
  572. <label class="md-nav__link" for="__nav_3_5" id="__nav_3_5_label" tabindex="0">
  573. <span class="md-ellipsis">
  574. Operations
  575. </span>
  576. <span class="md-nav__icon md-icon"></span>
  577. </label>
  578. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_5_label" aria-expanded="false">
  579. <label class="md-nav__title" for="__nav_3_5">
  580. <span class="md-nav__icon md-icon"></span>
  581. Operations
  582. </label>
  583. <ul class="md-nav__list" data-md-scrollfix>
  584. <li class="md-nav__item">
  585. <a href="../../guides/multi-tenancy/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Multi Tenancy
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../../guides/security-best-practices/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Security Best Practices
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item">
  599. <a href="../../guides/threat-model/" class="md-nav__link">
  600. <span class="md-ellipsis">
  601. Threat Model
  602. </span>
  603. </a>
  604. </li>
  605. <li class="md-nav__item">
  606. <a href="../../guides/v1beta1/" class="md-nav__link">
  607. <span class="md-ellipsis">
  608. Upgrading to v1beta1
  609. </span>
  610. </a>
  611. </li>
  612. <li class="md-nav__item">
  613. <a href="../../guides/using-latest-image/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Using Latest Image
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../../guides/disable-cluster-features/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Disable Cluster Features
  623. </span>
  624. </a>
  625. </li>
  626. </ul>
  627. </nav>
  628. </li>
  629. </ul>
  630. </nav>
  631. </li>
  632. <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
  633. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
  634. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
  635. <span class="md-ellipsis">
  636. Provider
  637. </span>
  638. <span class="md-nav__icon md-icon"></span>
  639. </label>
  640. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
  641. <label class="md-nav__title" for="__nav_4">
  642. <span class="md-nav__icon md-icon"></span>
  643. Provider
  644. </label>
  645. <ul class="md-nav__list" data-md-scrollfix>
  646. <li class="md-nav__item">
  647. <a href="../aws-secrets-manager/" class="md-nav__link">
  648. <span class="md-ellipsis">
  649. AWS Secrets Manager
  650. </span>
  651. </a>
  652. </li>
  653. <li class="md-nav__item md-nav__item--active">
  654. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  655. <label class="md-nav__link md-nav__link--active" for="__toc">
  656. <span class="md-ellipsis">
  657. AWS Parameter Store
  658. </span>
  659. <span class="md-nav__icon md-icon"></span>
  660. </label>
  661. <a href="./" class="md-nav__link md-nav__link--active">
  662. <span class="md-ellipsis">
  663. AWS Parameter Store
  664. </span>
  665. </a>
  666. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  667. <label class="md-nav__title" for="__toc">
  668. <span class="md-nav__icon md-icon"></span>
  669. Table of contents
  670. </label>
  671. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  672. <li class="md-nav__item">
  673. <a href="#parameter-store" class="md-nav__link">
  674. <span class="md-ellipsis">
  675. Parameter Store
  676. </span>
  677. </a>
  678. <nav class="md-nav" aria-label="Parameter Store">
  679. <ul class="md-nav__list">
  680. <li class="md-nav__item">
  681. <a href="#iam-policy" class="md-nav__link">
  682. <span class="md-ellipsis">
  683. IAM Policy
  684. </span>
  685. </a>
  686. <nav class="md-nav" aria-label="IAM Policy">
  687. <ul class="md-nav__list">
  688. <li class="md-nav__item">
  689. <a href="#fetching-parameters" class="md-nav__link">
  690. <span class="md-ellipsis">
  691. Fetching Parameters
  692. </span>
  693. </a>
  694. </li>
  695. <li class="md-nav__item">
  696. <a href="#pushing-parameters" class="md-nav__link">
  697. <span class="md-ellipsis">
  698. Pushing Parameters
  699. </span>
  700. </a>
  701. </li>
  702. </ul>
  703. </nav>
  704. </li>
  705. <li class="md-nav__item">
  706. <a href="#json-secret-values" class="md-nav__link">
  707. <span class="md-ellipsis">
  708. JSON Secret Values
  709. </span>
  710. </a>
  711. </li>
  712. <li class="md-nav__item">
  713. <a href="#parameter-versions" class="md-nav__link">
  714. <span class="md-ellipsis">
  715. Parameter Versions
  716. </span>
  717. </a>
  718. </li>
  719. </ul>
  720. </nav>
  721. </li>
  722. <li class="md-nav__item">
  723. <a href="#setsecret" class="md-nav__link">
  724. <span class="md-ellipsis">
  725. SetSecret
  726. </span>
  727. </a>
  728. <nav class="md-nav" aria-label="SetSecret">
  729. <ul class="md-nav__list">
  730. <li class="md-nav__item">
  731. <a href="#creating-a-push-secret" class="md-nav__link">
  732. <span class="md-ellipsis">
  733. Creating a Push Secret
  734. </span>
  735. </a>
  736. <nav class="md-nav" aria-label="Creating a Push Secret">
  737. <ul class="md-nav__list">
  738. <li class="md-nav__item">
  739. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  740. <span class="md-ellipsis">
  741. Additional Metadata for PushSecret
  742. </span>
  743. </a>
  744. </li>
  745. <li class="md-nav__item">
  746. <a href="#check-successful-secret-sync" class="md-nav__link">
  747. <span class="md-ellipsis">
  748. Check successful secret sync
  749. </span>
  750. </a>
  751. </li>
  752. <li class="md-nav__item">
  753. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  754. <span class="md-ellipsis">
  755. Test new secret using AWS CLI
  756. </span>
  757. </a>
  758. </li>
  759. </ul>
  760. </nav>
  761. </li>
  762. </ul>
  763. </nav>
  764. </li>
  765. <li class="md-nav__item">
  766. <a href="#aws-authentication" class="md-nav__link">
  767. <span class="md-ellipsis">
  768. AWS Authentication
  769. </span>
  770. </a>
  771. <nav class="md-nav" aria-label="AWS Authentication">
  772. <ul class="md-nav__list">
  773. <li class="md-nav__item">
  774. <a href="#controllers-pod-identity" class="md-nav__link">
  775. <span class="md-ellipsis">
  776. Controller's Pod Identity
  777. </span>
  778. </a>
  779. </li>
  780. <li class="md-nav__item">
  781. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  782. <span class="md-ellipsis">
  783. Access Key ID &amp; Secret Access Key
  784. </span>
  785. </a>
  786. </li>
  787. <li class="md-nav__item">
  788. <a href="#eks-service-account-credentials" class="md-nav__link">
  789. <span class="md-ellipsis">
  790. EKS Service Account credentials
  791. </span>
  792. </a>
  793. </li>
  794. </ul>
  795. </nav>
  796. </li>
  797. <li class="md-nav__item">
  798. <a href="#custom-endpoints" class="md-nav__link">
  799. <span class="md-ellipsis">
  800. Custom Endpoints
  801. </span>
  802. </a>
  803. </li>
  804. </ul>
  805. </nav>
  806. </li>
  807. <li class="md-nav__item">
  808. <a href="../azure-key-vault/" class="md-nav__link">
  809. <span class="md-ellipsis">
  810. Azure Key Vault
  811. </span>
  812. </a>
  813. </li>
  814. <li class="md-nav__item">
  815. <a href="../beyondtrust/" class="md-nav__link">
  816. <span class="md-ellipsis">
  817. BeyondTrust
  818. </span>
  819. </a>
  820. </li>
  821. <li class="md-nav__item">
  822. <a href="../bitwarden-secrets-manager/" class="md-nav__link">
  823. <span class="md-ellipsis">
  824. Bitwarden Secrets Manager
  825. </span>
  826. </a>
  827. </li>
  828. <li class="md-nav__item">
  829. <a href="../chef/" class="md-nav__link">
  830. <span class="md-ellipsis">
  831. Chef
  832. </span>
  833. </a>
  834. </li>
  835. <li class="md-nav__item">
  836. <a href="../conjur/" class="md-nav__link">
  837. <span class="md-ellipsis">
  838. CyberArk Conjur
  839. </span>
  840. </a>
  841. </li>
  842. <li class="md-nav__item">
  843. <a href="../device42/" class="md-nav__link">
  844. <span class="md-ellipsis">
  845. Device42
  846. </span>
  847. </a>
  848. </li>
  849. <li class="md-nav__item">
  850. <a href="../google-secrets-manager/" class="md-nav__link">
  851. <span class="md-ellipsis">
  852. Google Cloud Secret Manager
  853. </span>
  854. </a>
  855. </li>
  856. <li class="md-nav__item">
  857. <a href="../hashicorp-vault/" class="md-nav__link">
  858. <span class="md-ellipsis">
  859. HashiCorp Vault
  860. </span>
  861. </a>
  862. </li>
  863. <li class="md-nav__item">
  864. <a href="../kubernetes/" class="md-nav__link">
  865. <span class="md-ellipsis">
  866. Kubernetes
  867. </span>
  868. </a>
  869. </li>
  870. <li class="md-nav__item">
  871. <a href="../ibm-secrets-manager/" class="md-nav__link">
  872. <span class="md-ellipsis">
  873. IBM Secrets Manager
  874. </span>
  875. </a>
  876. </li>
  877. <li class="md-nav__item">
  878. <a href="../akeyless/" class="md-nav__link">
  879. <span class="md-ellipsis">
  880. Akeyless
  881. </span>
  882. </a>
  883. </li>
  884. <li class="md-nav__item">
  885. <a href="../yandex-certificate-manager/" class="md-nav__link">
  886. <span class="md-ellipsis">
  887. Yandex Certificate Manager
  888. </span>
  889. </a>
  890. </li>
  891. <li class="md-nav__item">
  892. <a href="../yandex-lockbox/" class="md-nav__link">
  893. <span class="md-ellipsis">
  894. Yandex Lockbox
  895. </span>
  896. </a>
  897. </li>
  898. <li class="md-nav__item">
  899. <a href="../alibaba/" class="md-nav__link">
  900. <span class="md-ellipsis">
  901. Alibaba Cloud
  902. </span>
  903. </a>
  904. </li>
  905. <li class="md-nav__item">
  906. <a href="../gitlab-variables/" class="md-nav__link">
  907. <span class="md-ellipsis">
  908. GitLab Variables
  909. </span>
  910. </a>
  911. </li>
  912. <li class="md-nav__item">
  913. <a href="../oracle-vault/" class="md-nav__link">
  914. <span class="md-ellipsis">
  915. Oracle Vault
  916. </span>
  917. </a>
  918. </li>
  919. <li class="md-nav__item">
  920. <a href="../1password-automation/" class="md-nav__link">
  921. <span class="md-ellipsis">
  922. 1Password Secrets Automation
  923. </span>
  924. </a>
  925. </li>
  926. <li class="md-nav__item">
  927. <a href="../webhook/" class="md-nav__link">
  928. <span class="md-ellipsis">
  929. Webhook
  930. </span>
  931. </a>
  932. </li>
  933. <li class="md-nav__item">
  934. <a href="../fake/" class="md-nav__link">
  935. <span class="md-ellipsis">
  936. Fake
  937. </span>
  938. </a>
  939. </li>
  940. <li class="md-nav__item">
  941. <a href="../senhasegura-dsm/" class="md-nav__link">
  942. <span class="md-ellipsis">
  943. senhasegura DevOps Secrets Management (DSM)
  944. </span>
  945. </a>
  946. </li>
  947. <li class="md-nav__item">
  948. <a href="../doppler/" class="md-nav__link">
  949. <span class="md-ellipsis">
  950. Doppler
  951. </span>
  952. </a>
  953. </li>
  954. <li class="md-nav__item">
  955. <a href="../keeper-security/" class="md-nav__link">
  956. <span class="md-ellipsis">
  957. Keeper Security
  958. </span>
  959. </a>
  960. </li>
  961. <li class="md-nav__item">
  962. <a href="../cloak/" class="md-nav__link">
  963. <span class="md-ellipsis">
  964. Cloak End 2 End Encrypted Secrets
  965. </span>
  966. </a>
  967. </li>
  968. <li class="md-nav__item">
  969. <a href="../scaleway/" class="md-nav__link">
  970. <span class="md-ellipsis">
  971. Scaleway
  972. </span>
  973. </a>
  974. </li>
  975. <li class="md-nav__item">
  976. <a href="../delinea/" class="md-nav__link">
  977. <span class="md-ellipsis">
  978. Delinea
  979. </span>
  980. </a>
  981. </li>
  982. <li class="md-nav__item">
  983. <a href="../secretserver/" class="md-nav__link">
  984. <span class="md-ellipsis">
  985. Secret Server
  986. </span>
  987. </a>
  988. </li>
  989. <li class="md-nav__item">
  990. <a href="../passbolt/" class="md-nav__link">
  991. <span class="md-ellipsis">
  992. Passbolt
  993. </span>
  994. </a>
  995. </li>
  996. <li class="md-nav__item">
  997. <a href="../pulumi/" class="md-nav__link">
  998. <span class="md-ellipsis">
  999. Pulumi ESC
  1000. </span>
  1001. </a>
  1002. </li>
  1003. <li class="md-nav__item">
  1004. <a href="../onboardbase/" class="md-nav__link">
  1005. <span class="md-ellipsis">
  1006. Onboardbase
  1007. </span>
  1008. </a>
  1009. </li>
  1010. <li class="md-nav__item">
  1011. <a href="../../provider-passworddepot/" class="md-nav__link">
  1012. <span class="md-ellipsis">
  1013. Password Depot
  1014. </span>
  1015. </a>
  1016. </li>
  1017. <li class="md-nav__item">
  1018. <a href="../fortanix/" class="md-nav__link">
  1019. <span class="md-ellipsis">
  1020. Fortanix
  1021. </span>
  1022. </a>
  1023. </li>
  1024. <li class="md-nav__item">
  1025. <a href="../infisical/" class="md-nav__link">
  1026. <span class="md-ellipsis">
  1027. Infisical
  1028. </span>
  1029. </a>
  1030. </li>
  1031. <li class="md-nav__item">
  1032. <a href="../previder/" class="md-nav__link">
  1033. <span class="md-ellipsis">
  1034. Previder
  1035. </span>
  1036. </a>
  1037. </li>
  1038. </ul>
  1039. </nav>
  1040. </li>
  1041. <li class="md-nav__item md-nav__item--nested">
  1042. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
  1043. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  1044. <span class="md-ellipsis">
  1045. Examples
  1046. </span>
  1047. <span class="md-nav__icon md-icon"></span>
  1048. </label>
  1049. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  1050. <label class="md-nav__title" for="__nav_5">
  1051. <span class="md-nav__icon md-icon"></span>
  1052. Examples
  1053. </label>
  1054. <ul class="md-nav__list" data-md-scrollfix>
  1055. <li class="md-nav__item">
  1056. <a href="../../examples/gitops-using-fluxcd/" class="md-nav__link">
  1057. <span class="md-ellipsis">
  1058. FluxCD
  1059. </span>
  1060. </a>
  1061. </li>
  1062. <li class="md-nav__item">
  1063. <a href="../../examples/anchore-engine-credentials/" class="md-nav__link">
  1064. <span class="md-ellipsis">
  1065. Anchore Engine
  1066. </span>
  1067. </a>
  1068. </li>
  1069. <li class="md-nav__item">
  1070. <a href="../../examples/jenkins-kubernetes-credentials/" class="md-nav__link">
  1071. <span class="md-ellipsis">
  1072. Jenkins
  1073. </span>
  1074. </a>
  1075. </li>
  1076. <li class="md-nav__item">
  1077. <a href="../../examples/bitwarden/" class="md-nav__link">
  1078. <span class="md-ellipsis">
  1079. BitWarden
  1080. </span>
  1081. </a>
  1082. </li>
  1083. </ul>
  1084. </nav>
  1085. </li>
  1086. <li class="md-nav__item md-nav__item--nested">
  1087. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
  1088. <label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
  1089. <span class="md-ellipsis">
  1090. Community
  1091. </span>
  1092. <span class="md-nav__icon md-icon"></span>
  1093. </label>
  1094. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  1095. <label class="md-nav__title" for="__nav_6">
  1096. <span class="md-nav__icon md-icon"></span>
  1097. Community
  1098. </label>
  1099. <ul class="md-nav__list" data-md-scrollfix>
  1100. <li class="md-nav__item md-nav__item--nested">
  1101. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_1" >
  1102. <label class="md-nav__link" for="__nav_6_1" id="__nav_6_1_label" tabindex="0">
  1103. <span class="md-ellipsis">
  1104. Contributing
  1105. </span>
  1106. <span class="md-nav__icon md-icon"></span>
  1107. </label>
  1108. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_1_label" aria-expanded="false">
  1109. <label class="md-nav__title" for="__nav_6_1">
  1110. <span class="md-nav__icon md-icon"></span>
  1111. Contributing
  1112. </label>
  1113. <ul class="md-nav__list" data-md-scrollfix>
  1114. <li class="md-nav__item">
  1115. <a href="../../contributing/devguide/" class="md-nav__link">
  1116. <span class="md-ellipsis">
  1117. Developer guide
  1118. </span>
  1119. </a>
  1120. </li>
  1121. <li class="md-nav__item">
  1122. <a href="../../contributing/process/" class="md-nav__link">
  1123. <span class="md-ellipsis">
  1124. Contributing Process
  1125. </span>
  1126. </a>
  1127. </li>
  1128. <li class="md-nav__item">
  1129. <a href="../../contributing/release/" class="md-nav__link">
  1130. <span class="md-ellipsis">
  1131. Release Process
  1132. </span>
  1133. </a>
  1134. </li>
  1135. <li class="md-nav__item">
  1136. <a href="../../contributing/coc/" class="md-nav__link">
  1137. <span class="md-ellipsis">
  1138. Code of Conduct
  1139. </span>
  1140. </a>
  1141. </li>
  1142. <li class="md-nav__item">
  1143. <a href="../../contributing/roadmap/" class="md-nav__link">
  1144. <span class="md-ellipsis">
  1145. Roadmap
  1146. </span>
  1147. </a>
  1148. </li>
  1149. </ul>
  1150. </nav>
  1151. </li>
  1152. <li class="md-nav__item md-nav__item--nested">
  1153. <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6_2" >
  1154. <label class="md-nav__link" for="__nav_6_2" id="__nav_6_2_label" tabindex="0">
  1155. <span class="md-ellipsis">
  1156. External Resources
  1157. </span>
  1158. <span class="md-nav__icon md-icon"></span>
  1159. </label>
  1160. <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_2_label" aria-expanded="false">
  1161. <label class="md-nav__title" for="__nav_6_2">
  1162. <span class="md-nav__icon md-icon"></span>
  1163. External Resources
  1164. </label>
  1165. <ul class="md-nav__list" data-md-scrollfix>
  1166. <li class="md-nav__item">
  1167. <a href="../../eso-talks/" class="md-nav__link">
  1168. <span class="md-ellipsis">
  1169. Talks
  1170. </span>
  1171. </a>
  1172. </li>
  1173. <li class="md-nav__item">
  1174. <a href="../../eso-demos/" class="md-nav__link">
  1175. <span class="md-ellipsis">
  1176. Demos
  1177. </span>
  1178. </a>
  1179. </li>
  1180. <li class="md-nav__item">
  1181. <a href="../../eso-blogs/" class="md-nav__link">
  1182. <span class="md-ellipsis">
  1183. Blogs
  1184. </span>
  1185. </a>
  1186. </li>
  1187. <li class="md-nav__item">
  1188. <a href="../../eso-tools/" class="md-nav__link">
  1189. <span class="md-ellipsis">
  1190. Tools
  1191. </span>
  1192. </a>
  1193. </li>
  1194. </ul>
  1195. </nav>
  1196. </li>
  1197. </ul>
  1198. </nav>
  1199. </li>
  1200. </ul>
  1201. </nav>
  1202. </div>
  1203. </div>
  1204. </div>
  1205. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  1206. <div class="md-sidebar__scrollwrap">
  1207. <div class="md-sidebar__inner">
  1208. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  1209. <label class="md-nav__title" for="__toc">
  1210. <span class="md-nav__icon md-icon"></span>
  1211. Table of contents
  1212. </label>
  1213. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  1214. <li class="md-nav__item">
  1215. <a href="#parameter-store" class="md-nav__link">
  1216. <span class="md-ellipsis">
  1217. Parameter Store
  1218. </span>
  1219. </a>
  1220. <nav class="md-nav" aria-label="Parameter Store">
  1221. <ul class="md-nav__list">
  1222. <li class="md-nav__item">
  1223. <a href="#iam-policy" class="md-nav__link">
  1224. <span class="md-ellipsis">
  1225. IAM Policy
  1226. </span>
  1227. </a>
  1228. <nav class="md-nav" aria-label="IAM Policy">
  1229. <ul class="md-nav__list">
  1230. <li class="md-nav__item">
  1231. <a href="#fetching-parameters" class="md-nav__link">
  1232. <span class="md-ellipsis">
  1233. Fetching Parameters
  1234. </span>
  1235. </a>
  1236. </li>
  1237. <li class="md-nav__item">
  1238. <a href="#pushing-parameters" class="md-nav__link">
  1239. <span class="md-ellipsis">
  1240. Pushing Parameters
  1241. </span>
  1242. </a>
  1243. </li>
  1244. </ul>
  1245. </nav>
  1246. </li>
  1247. <li class="md-nav__item">
  1248. <a href="#json-secret-values" class="md-nav__link">
  1249. <span class="md-ellipsis">
  1250. JSON Secret Values
  1251. </span>
  1252. </a>
  1253. </li>
  1254. <li class="md-nav__item">
  1255. <a href="#parameter-versions" class="md-nav__link">
  1256. <span class="md-ellipsis">
  1257. Parameter Versions
  1258. </span>
  1259. </a>
  1260. </li>
  1261. </ul>
  1262. </nav>
  1263. </li>
  1264. <li class="md-nav__item">
  1265. <a href="#setsecret" class="md-nav__link">
  1266. <span class="md-ellipsis">
  1267. SetSecret
  1268. </span>
  1269. </a>
  1270. <nav class="md-nav" aria-label="SetSecret">
  1271. <ul class="md-nav__list">
  1272. <li class="md-nav__item">
  1273. <a href="#creating-a-push-secret" class="md-nav__link">
  1274. <span class="md-ellipsis">
  1275. Creating a Push Secret
  1276. </span>
  1277. </a>
  1278. <nav class="md-nav" aria-label="Creating a Push Secret">
  1279. <ul class="md-nav__list">
  1280. <li class="md-nav__item">
  1281. <a href="#additional-metadata-for-pushsecret" class="md-nav__link">
  1282. <span class="md-ellipsis">
  1283. Additional Metadata for PushSecret
  1284. </span>
  1285. </a>
  1286. </li>
  1287. <li class="md-nav__item">
  1288. <a href="#check-successful-secret-sync" class="md-nav__link">
  1289. <span class="md-ellipsis">
  1290. Check successful secret sync
  1291. </span>
  1292. </a>
  1293. </li>
  1294. <li class="md-nav__item">
  1295. <a href="#test-new-secret-using-aws-cli" class="md-nav__link">
  1296. <span class="md-ellipsis">
  1297. Test new secret using AWS CLI
  1298. </span>
  1299. </a>
  1300. </li>
  1301. </ul>
  1302. </nav>
  1303. </li>
  1304. </ul>
  1305. </nav>
  1306. </li>
  1307. <li class="md-nav__item">
  1308. <a href="#aws-authentication" class="md-nav__link">
  1309. <span class="md-ellipsis">
  1310. AWS Authentication
  1311. </span>
  1312. </a>
  1313. <nav class="md-nav" aria-label="AWS Authentication">
  1314. <ul class="md-nav__list">
  1315. <li class="md-nav__item">
  1316. <a href="#controllers-pod-identity" class="md-nav__link">
  1317. <span class="md-ellipsis">
  1318. Controller's Pod Identity
  1319. </span>
  1320. </a>
  1321. </li>
  1322. <li class="md-nav__item">
  1323. <a href="#access-key-id-secret-access-key" class="md-nav__link">
  1324. <span class="md-ellipsis">
  1325. Access Key ID &amp; Secret Access Key
  1326. </span>
  1327. </a>
  1328. </li>
  1329. <li class="md-nav__item">
  1330. <a href="#eks-service-account-credentials" class="md-nav__link">
  1331. <span class="md-ellipsis">
  1332. EKS Service Account credentials
  1333. </span>
  1334. </a>
  1335. </li>
  1336. </ul>
  1337. </nav>
  1338. </li>
  1339. <li class="md-nav__item">
  1340. <a href="#custom-endpoints" class="md-nav__link">
  1341. <span class="md-ellipsis">
  1342. Custom Endpoints
  1343. </span>
  1344. </a>
  1345. </li>
  1346. </ul>
  1347. </nav>
  1348. </div>
  1349. </div>
  1350. </div>
  1351. <div class="md-content" data-md-component="content">
  1352. <article class="md-content__inner md-typeset">
  1353. <h1>AWS Parameter Store</h1>
  1354. <p><img alt="aws sm" src="../../pictures/diagrams-provider-aws-ssm-parameter-store.png" /></p>
  1355. <h2 id="parameter-store">Parameter Store</h2>
  1356. <p>A <code>ParameterStore</code> points to AWS SSM Parameter Store in a certain account within a
  1357. defined region. You should define Roles that define fine-grained access to
  1358. individual secrets and pass them to ESO using <code>spec.provider.aws.role</code>. This
  1359. way users of the <code>SecretStore</code> can only access the secrets necessary.</p>
  1360. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1361. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1362. <span class="nt">metadata</span><span class="p">:</span>
  1363. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">parameterstore</span>
  1364. <span class="nt">spec</span><span class="p">:</span>
  1365. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1366. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1367. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ParameterStore</span>
  1368. <span class="w"> </span><span class="c1"># define a specific role to limit access</span>
  1369. <span class="w"> </span><span class="c1"># to certain secrets</span>
  1370. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/external-secrets</span>
  1371. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1372. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1373. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1374. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1375. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1376. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  1377. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1378. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1379. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  1380. </code></pre></div>
  1381. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code> and <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  1382. <div class="admonition warning">
  1383. <p class="admonition-title">API Pricing &amp; Throttling</p>
  1384. <p>The SSM Parameter Store API is charged by throughput and
  1385. is available in different tiers, <a href="https://aws.amazon.com/systems-manager/pricing/#Parameter_Store">see pricing</a>.
  1386. Please estimate your costs before using ESO. Cost depends on the RefreshInterval of your ExternalSecrets.</p>
  1387. </div>
  1388. <h3 id="iam-policy">IAM Policy</h3>
  1389. <h4 id="fetching-parameters">Fetching Parameters</h4>
  1390. <p>The example policy below shows the minimum required permissions for fetching SSM parameters. This policy permits pinning down access to secrets with a path matching <code>dev-*</code>. Other operations may require additional permission. For example, finding parameters based on tags will also require <code>ssm:DescribeParameters</code> and <code>tag:GetResources</code> permission with <code>"Resource": "*"</code>. Generally, the specific permission required will be logged as an error if an operation fails.</p>
  1391. <p>For further information see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-access.html">AWS Documentation</a>.</p>
  1392. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1393. <span class="w"> </span><span class="nt">&quot;Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2012-10-17&quot;</span><span class="p">,</span>
  1394. <span class="w"> </span><span class="nt">&quot;Statement&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1395. <span class="w"> </span><span class="p">{</span>
  1396. <span class="w"> </span><span class="nt">&quot;Effect&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Allow&quot;</span><span class="p">,</span>
  1397. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1398. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1399. <span class="w"> </span><span class="p">],</span>
  1400. <span class="w"> </span><span class="nt">&quot;Resource&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-2:1234567889911:parameter/dev-*&quot;</span>
  1401. <span class="w"> </span><span class="p">}</span>
  1402. <span class="w"> </span><span class="p">]</span>
  1403. <span class="p">}</span>
  1404. </code></pre></div>
  1405. <h4 id="pushing-parameters">Pushing Parameters</h4>
  1406. <p>The example policy below shows the minimum required permissions for pushing SSM parameters. Like with the fetching policy it restricts the path in which it can push secrets too.</p>
  1407. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1408. <span class="w"> </span><span class="nt">&quot;Action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1409. <span class="w"> </span><span class="s2">&quot;ssm:GetParameter*&quot;</span><span class="p">,</span>
  1410. <span class="w"> </span><span class="s2">&quot;ssm:PutParameter*&quot;</span><span class="p">,</span>
  1411. <span class="w"> </span><span class="s2">&quot;ssm:AddTagsToResource&quot;</span><span class="p">,</span>
  1412. <span class="w"> </span><span class="s2">&quot;ssm:ListTagsForResource&quot;</span>
  1413. <span class="w"> </span><span class="p">],</span>
  1414. <span class="w"> </span><span class="nt">&quot;Effect&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Allow&quot;</span><span class="p">,</span>
  1415. <span class="w"> </span><span class="nt">&quot;Resource&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-2:1234567889911:parameter/dev-*&quot;</span>
  1416. <span class="p">}</span>
  1417. </code></pre></div>
  1418. <h3 id="json-secret-values">JSON Secret Values</h3>
  1419. <p>You can store JSON objects in a parameter. You can access nested values or arrays using <a href="https://github.com/tidwall/gjson/blob/master/SYNTAX.md">gjson syntax</a>:</p>
  1420. <p>Consider the following JSON object that is stored in the Parameter Store key <code>friendslist</code>:</p>
  1421. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1422. <span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Tom&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Anderson&quot;</span><span class="p">},</span>
  1423. <span class="w"> </span><span class="nt">&quot;friends&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
  1424. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Dale&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Murphy&quot;</span><span class="p">},</span>
  1425. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Roger&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Craig&quot;</span><span class="p">},</span>
  1426. <span class="w"> </span><span class="p">{</span><span class="nt">&quot;first&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Jane&quot;</span><span class="p">,</span><span class="w"> </span><span class="nt">&quot;last&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Murphy&quot;</span><span class="p">}</span>
  1427. <span class="w"> </span><span class="p">]</span>
  1428. <span class="p">}</span>
  1429. </code></pre></div>
  1430. <p>This is an example on how you would look up nested keys in the above json object:</p>
  1431. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1432. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ExternalSecret</span>
  1433. <span class="nt">metadata</span><span class="p">:</span>
  1434. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">extract-data</span>
  1435. <span class="nt">spec</span><span class="p">:</span>
  1436. <span class="w"> </span><span class="c1"># [omitted for brevity]</span>
  1437. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1438. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my_name</span>
  1439. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1440. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span>
  1441. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">name.first</span><span class="w"> </span><span class="c1"># Tom</span>
  1442. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">first_friend</span>
  1443. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1444. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friendslist</span>
  1445. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">friends.1.first</span><span class="w"> </span><span class="c1"># Roger</span>
  1446. <span class="w"> </span><span class="c1"># metadataPolicy to fetch all the tags in JSON format</span>
  1447. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">tags</span>
  1448. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1449. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1450. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1451. <span class="w"> </span><span class="c1"># metadataPolicy to fetch a specific tag (dev) from the source secret</span>
  1452. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">developer</span>
  1453. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1454. <span class="w"> </span><span class="nt">metadataPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Fetch</span>
  1455. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">database-credentials</span>
  1456. <span class="w"> </span><span class="nt">property</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">dev</span>
  1457. </code></pre></div>
  1458. <h3 id="parameter-versions">Parameter Versions</h3>
  1459. <p>ParameterStore creates a new version of a parameter every time it is updated with a new value. The parameter can be referenced via the <code>version</code> property</p>
  1460. <h2 id="setsecret">SetSecret</h2>
  1461. <p>The SetSecret method for the Parameter Store allows the user to set the value stored within the Kubernetes cluster to the remote AWS Parameter Store.</p>
  1462. <h3 id="creating-a-push-secret">Creating a Push Secret</h3>
  1463. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  1464. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1465. <span class="nt">metadata</span><span class="p">:</span>
  1466. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pushsecret-example</span><span class="w"> </span><span class="c1"># Customisable</span>
  1467. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"> </span><span class="c1"># Same of the SecretStores</span>
  1468. <span class="nt">spec</span><span class="p">:</span>
  1469. <span class="w"> </span><span class="nt">updatePolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Replace</span><span class="w"> </span><span class="c1"># Policy to overwrite existing secrets in the provider on sync</span>
  1470. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1471. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1472. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1473. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-parameterstore</span>
  1474. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1475. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1476. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1477. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pokedex-credentials</span><span class="w"> </span><span class="c1"># Source Kubernetes secret to be pushed</span>
  1478. <span class="w"> </span><span class="c1"># Alternatively, you can point to a generator that produces values to be pushed</span>
  1479. <span class="w"> </span><span class="nt">generatorRef</span><span class="p">:</span>
  1480. <span class="w"> </span><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  1481. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ECRAuthorizationToken</span>
  1482. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">prod-registry-credentials</span>
  1483. <span class="w"> </span><span class="nt">template</span><span class="p">:</span>
  1484. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1485. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1486. <span class="w"> </span><span class="nt">labels</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="w"> </span><span class="p p-Indicator">}</span>
  1487. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1488. <span class="w"> </span><span class="nt">best-pokemon</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;{{</span><span class="nv"> </span><span class="s">.best-pokemon</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">toString</span><span class="nv"> </span><span class="s">|</span><span class="nv"> </span><span class="s">upper</span><span class="nv"> </span><span class="s">}}</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">the</span><span class="nv"> </span><span class="s">really</span><span class="nv"> </span><span class="s">best!&quot;</span>
  1489. <span class="w"> </span><span class="c1"># Uses an existing template from configmap</span>
  1490. <span class="w"> </span><span class="c1"># Secret is fetched, merged and templated within the referenced configMap data</span>
  1491. <span class="w"> </span><span class="c1"># It does not update the configmap, it creates a secret with: data[&quot;alertmanager.yml&quot;] = ...result...</span>
  1492. <span class="w"> </span><span class="nt">templateFrom</span><span class="p">:</span>
  1493. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">configMap</span><span class="p">:</span>
  1494. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">application-config-tmpl</span>
  1495. <span class="w"> </span><span class="nt">items</span><span class="p">:</span>
  1496. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">config.yml</span>
  1497. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1498. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">conversionStrategy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">None</span><span class="w"> </span><span class="c1"># Also supports the ReverseUnicode strategy</span>
  1499. <span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1500. <span class="w"> </span><span class="nt">secretKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">best-pokemon</span><span class="w"> </span><span class="c1"># Source Kubernetes secret key to be pushed</span>
  1501. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1502. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-first-parameter</span><span class="w"> </span><span class="c1"># Remote reference (where the secret is going to be pushed)</span>
  1503. </code></pre></div>
  1504. <h4 id="additional-metadata-for-pushsecret">Additional Metadata for PushSecret</h4>
  1505. <p>Optionally, it is possible to configure additional options for the parameter such as <code>Type</code> and encryption Key. To control this behaviour you can set the following provider's <code>metadata</code>:</p>
  1506. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1alpha1</span>
  1507. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PushSecret</span>
  1508. <span class="nt">metadata</span><span class="p">:</span>
  1509. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pushsecret-example</span><span class="w"> </span><span class="c1"># Customisable</span>
  1510. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span><span class="w"> </span><span class="c1"># Same of the SecretStores</span>
  1511. <span class="nt">spec</span><span class="p">:</span>
  1512. <span class="w"> </span><span class="nt">deletionPolicy</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Delete</span><span class="w"> </span><span class="c1"># the provider&#39; secret will be deleted if the PushSecret is deleted</span>
  1513. <span class="w"> </span><span class="nt">refreshInterval</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1h</span><span class="w"> </span><span class="c1"># Refresh interval for which push secret will reconcile</span>
  1514. <span class="w"> </span><span class="nt">secretStoreRefs</span><span class="p">:</span><span class="w"> </span><span class="c1"># A list of secret stores to push secrets to</span>
  1515. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">aws-parameterstore</span>
  1516. <span class="w"> </span><span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1517. <span class="w"> </span><span class="nt">selector</span><span class="p">:</span>
  1518. <span class="w"> </span><span class="nt">secret</span><span class="p">:</span>
  1519. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">pokedex-credentials</span><span class="w"> </span><span class="c1"># Source Kubernetes secret to be pushed</span>
  1520. <span class="w"> </span><span class="nt">data</span><span class="p">:</span>
  1521. <span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">match</span><span class="p">:</span>
  1522. <span class="w"> </span><span class="nt">remoteRef</span><span class="p">:</span>
  1523. <span class="w"> </span><span class="nt">remoteKey</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-first-parameter</span><span class="w"> </span><span class="c1"># Remote reference (where the secret is going to be pushed)</span>
  1524. <span class="w"> </span><span class="nt">metadata</span><span class="p">:</span>
  1525. <span class="w"> </span><span class="nt">parameterStoreType</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;SecureString&quot;</span>
  1526. <span class="w"> </span><span class="nt">parameterStoreKeyID</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;bb123123-b2b0-4f60-ac3a-44a13f0e6b6c&quot;</span>
  1527. </code></pre></div>
  1528. <p><code>parameterStoreType</code> takes three options. <code>String</code>, <code>StringList</code>, and <code>SecureString</code>, where <code>String</code> is the <em>default</em>.</p>
  1529. <p><code>parameterStoreKeyID</code> takes a KMS Key <code>$ID</code> or <code>$ARN</code> (in case a key source is created in another account) as a string, where <code>alias/aws/ssm</code> is the <em>default</em>. This property is only used if <code>parameterStoreType</code> is set as <code>SecureString</code>.</p>
  1530. <h4 id="check-successful-secret-sync">Check successful secret sync</h4>
  1531. <p>To be able to check that the secret has been succesfully synced you can run the following command:</p>
  1532. <div class="highlight"><pre><span></span><code>kubectl<span class="w"> </span>get<span class="w"> </span>pushsecret<span class="w"> </span>pushsecret-example
  1533. </code></pre></div>
  1534. <p>If the secret has synced successfully it will show the status as "Synced".</p>
  1535. <h4 id="test-new-secret-using-aws-cli">Test new secret using AWS CLI</h4>
  1536. <p>To View your parameter on AWS Parameter Store using the AWS CLI, install and login to the AWS CLI using the following guide: <a href="https://aws.amazon.com/cli/">AWS CLI</a>.</p>
  1537. <p>Run the following commands to get your synchronized parameter from AWS Parameter Store:</p>
  1538. <div class="highlight"><pre><span></span><code>aws<span class="w"> </span>ssm<span class="w"> </span>get-parameter<span class="w"> </span>--name<span class="o">=</span>my-first-parameter<span class="w"> </span>--region<span class="o">=</span>us-east-1
  1539. </code></pre></div>
  1540. <p>You should see something similar to the following output:</p>
  1541. <div class="highlight"><pre><span></span><code><span class="p">{</span>
  1542. <span class="w"> </span><span class="nt">&quot;Parameter&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
  1543. <span class="w"> </span><span class="nt">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;my-first-parameter&quot;</span><span class="p">,</span>
  1544. <span class="w"> </span><span class="nt">&quot;Type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;String&quot;</span><span class="p">,</span>
  1545. <span class="w"> </span><span class="nt">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;charmander&quot;</span><span class="p">,</span>
  1546. <span class="w"> </span><span class="nt">&quot;Version&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">4</span><span class="p">,</span>
  1547. <span class="w"> </span><span class="nt">&quot;LastModifiedDate&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2022-09-15T13:04:31.098000-03:00&quot;</span><span class="p">,</span>
  1548. <span class="w"> </span><span class="nt">&quot;ARN&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;arn:aws:ssm:us-east-1:1234567890123:parameter/my-first-parameter&quot;</span><span class="p">,</span>
  1549. <span class="w"> </span><span class="nt">&quot;DataType&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text&quot;</span>
  1550. <span class="w"> </span><span class="p">}</span>
  1551. <span class="p">}</span>
  1552. </code></pre></div>
  1553. <h2 id="aws-authentication">AWS Authentication</h2>
  1554. <h3 id="controllers-pod-identity">Controller's Pod Identity</h3>
  1555. <p><img alt="Pod Identity Authentication" src="../../pictures/diagrams-provider-aws-auth-pod-identity.png" /></p>
  1556. <p>Note: If you are using Parameter Store replace <code>service: SecretsManager</code> with <code>service: ParameterStore</code> in all examples below.</p>
  1557. <p>This is basicially a zero-configuration authentication method that inherits the credentials from the runtime environment using the <a href="https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/credentials.html#credentials-default">aws sdk default credential chain</a>.</p>
  1558. <p>You can attach a role to the pod using <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html">IRSA</a>, <a href="https://github.com/uswitch/kiam">kiam</a> or <a href="https://github.com/jtblin/kube2iam">kube2iam</a>. When no other authentication method is configured in the <code>Kind=Secretstore</code> this role is used to make all API calls against AWS Secrets Manager or SSM Parameter Store.</p>
  1559. <p>Based on the Pod's identity you can do a <code>sts:assumeRole</code> before fetching the secrets to limit access to certain keys in your provider. This is optional.</p>
  1560. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1561. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1562. <span class="nt">metadata</span><span class="p">:</span>
  1563. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b-store</span>
  1564. <span class="nt">spec</span><span class="p">:</span>
  1565. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1566. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1567. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1568. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1569. <span class="w"> </span><span class="c1"># optional: do a sts:assumeRole before fetching secrets</span>
  1570. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b</span>
  1571. </code></pre></div>
  1572. <h3 id="access-key-id-secret-access-key">Access Key ID &amp; Secret Access Key</h3>
  1573. <p><img alt="SecretRef" src="../../pictures/diagrams-provider-aws-auth-secret-ref.png" /></p>
  1574. <p>You can store Access Key ID &amp; Secret Access Key in a <code>Kind=Secret</code> and reference it from a SecretStore.</p>
  1575. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1576. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1577. <span class="nt">metadata</span><span class="p">:</span>
  1578. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b-store</span>
  1579. <span class="nt">spec</span><span class="p">:</span>
  1580. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1581. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1582. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1583. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1584. <span class="w"> </span><span class="c1"># optional: assume role before fetching secrets</span>
  1585. <span class="w"> </span><span class="nt">role</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">team-b</span>
  1586. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1587. <span class="w"> </span><span class="nt">secretRef</span><span class="p">:</span>
  1588. <span class="w"> </span><span class="nt">accessKeyIDSecretRef</span><span class="p">:</span>
  1589. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1590. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">access-key</span>
  1591. <span class="w"> </span><span class="nt">secretAccessKeySecretRef</span><span class="p">:</span>
  1592. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">awssm-secret</span>
  1593. <span class="w"> </span><span class="nt">key</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secret-access-key</span>
  1594. </code></pre></div>
  1595. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> in <code>accessKeyIDSecretRef</code>, <code>secretAccessKeySecretRef</code> with the namespaces where the secrets reside.</p>
  1596. <h3 id="eks-service-account-credentials">EKS Service Account credentials</h3>
  1597. <p><img alt="Service Account" src="../../pictures/diagrams-provider-aws-auth-service-account.png" /></p>
  1598. <p>This feature lets you use short-lived service account tokens to authenticate with AWS.
  1599. You must have <a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#service-account-token-volume-projection">Service Account Volume Projection</a> enabled - it is by default on EKS. See <a href="https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts-technical-overview.html">EKS guide</a> on how to set up IAM roles for service accounts.</p>
  1600. <p>The big advantage of this approach is that ESO runs without any credentials.</p>
  1601. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">v1</span>
  1602. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ServiceAccount</span>
  1603. <span class="nt">metadata</span><span class="p">:</span>
  1604. <span class="w"> </span><span class="nt">annotations</span><span class="p">:</span>
  1605. <span class="w"> </span><span class="nt">eks.amazonaws.com/role-arn</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">arn:aws:iam::123456789012:role/team-a</span>
  1606. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  1607. <span class="w"> </span><span class="nt">namespace</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">default</span>
  1608. </code></pre></div>
  1609. <p>Reference the service account from above in the Secret Store:</p>
  1610. <div class="highlight"><pre><span></span><code><span class="nt">apiVersion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">external-secrets.io/v1beta1</span>
  1611. <span class="nt">kind</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretStore</span>
  1612. <span class="nt">metadata</span><span class="p">:</span>
  1613. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">secretstore-sample</span>
  1614. <span class="nt">spec</span><span class="p">:</span>
  1615. <span class="w"> </span><span class="nt">provider</span><span class="p">:</span>
  1616. <span class="w"> </span><span class="nt">aws</span><span class="p">:</span>
  1617. <span class="w"> </span><span class="nt">service</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SecretsManager</span>
  1618. <span class="w"> </span><span class="nt">region</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">eu-central-1</span>
  1619. <span class="w"> </span><span class="nt">auth</span><span class="p">:</span>
  1620. <span class="w"> </span><span class="nt">jwt</span><span class="p">:</span>
  1621. <span class="w"> </span><span class="nt">serviceAccountRef</span><span class="p">:</span>
  1622. <span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">my-serviceaccount</span>
  1623. </code></pre></div>
  1624. <p><strong>NOTE:</strong> In case of a <code>ClusterSecretStore</code>, Be sure to provide <code>namespace</code> for <code>serviceAccountRef</code> with the namespace where the service account resides.</p>
  1625. <h2 id="custom-endpoints">Custom Endpoints</h2>
  1626. <p>You can define custom AWS endpoints if you want to use regional, vpc or custom endpoints. See List of endpoints for <a href="https://docs.aws.amazon.com/general/latest/gr/asm.html">Secrets Manager</a>, <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html">Secure Systems Manager</a> and <a href="https://docs.aws.amazon.com/general/latest/gr/sts.html">Security Token Service</a>.</p>
  1627. <p>Use the following environment variables to point the controller to your custom endpoints. Note: All resources managed by this controller are affected.</p>
  1628. <table>
  1629. <thead>
  1630. <tr>
  1631. <th>ENV VAR</th>
  1632. <th>DESCRIPTION</th>
  1633. </tr>
  1634. </thead>
  1635. <tbody>
  1636. <tr>
  1637. <td>AWS_SECRETSMANAGER_ENDPOINT</td>
  1638. <td>Endpoint for the Secrets Manager Service. The controller uses this endpoint to fetch secrets from AWS Secrets Manager.</td>
  1639. </tr>
  1640. <tr>
  1641. <td>AWS_SSM_ENDPOINT</td>
  1642. <td>Endpoint for the AWS Secure Systems Manager. The controller uses this endpoint to fetch secrets from SSM Parameter Store.</td>
  1643. </tr>
  1644. <tr>
  1645. <td>AWS_STS_ENDPOINT</td>
  1646. <td>Endpoint for the Security Token Service. The controller uses this endpoint when creating a session and when doing <code>assumeRole</code> or <code>assumeRoleWithWebIdentity</code> calls.</td>
  1647. </tr>
  1648. </tbody>
  1649. </table>
  1650. </article>
  1651. </div>
  1652. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1653. </div>
  1654. </main>
  1655. <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=6658a9eb-067d-49f1-94f2-b8b00f21451e" />
  1656. <footer class="md-footer">
  1657. <div class="md-footer-meta md-typeset">
  1658. <div class="md-footer-meta__inner md-grid">
  1659. <div class="md-copyright">
  1660. <div class="md-copyright__highlight">
  1661. &copy; 2024 The external-secrets Authors.<br/>
  1662. &copy; 2024 The Linux Foundation. All rights reserved.<br/><br/>
  1663. The Linux Foundation has registered trademarks and uses trademarks.<br/>
  1664. For a list of trademarks of The Linux Foundation, please see our <a href="https://www.linuxfoundation.org/trademark-usage/">Trademark Usage page</a>.
  1665. </div>
  1666. Made with
  1667. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1668. Material for MkDocs
  1669. </a>
  1670. </div>
  1671. </div>
  1672. </div>
  1673. </footer>
  1674. </div>
  1675. <div class="md-dialog" data-md-component="dialog">
  1676. <div class="md-dialog__inner md-typeset"></div>
  1677. </div>
  1678. <script id="__config" type="application/json">{"base": "../..", "features": ["navigation.tabs", "navigation.indexes", "navigation.expand"], "search": "../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
  1679. <script src="../../assets/javascripts/bundle.83f73b43.min.js"></script>
  1680. </body>
  1681. </html>