123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class SecurityHub extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: SecurityHub.Types.ClientConfiguration)
- config: Config & SecurityHub.Types.ClientConfiguration;
- /**
- * Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- */
- acceptAdministratorInvitation(params: SecurityHub.Types.AcceptAdministratorInvitationRequest, callback?: (err: AWSError, data: SecurityHub.Types.AcceptAdministratorInvitationResponse) => void): Request<SecurityHub.Types.AcceptAdministratorInvitationResponse, AWSError>;
- /**
- * Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- */
- acceptAdministratorInvitation(callback?: (err: AWSError, data: SecurityHub.Types.AcceptAdministratorInvitationResponse) => void): Request<SecurityHub.Types.AcceptAdministratorInvitationResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use AcceptAdministratorInvitation. The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation. Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- */
- acceptInvitation(params: SecurityHub.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request<SecurityHub.Types.AcceptInvitationResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use AcceptAdministratorInvitation. The Security Hub console continues to use AcceptInvitation. It will eventually change to use AcceptAdministratorInvitation. Any IAM policies that specifically control access to this function must continue to use AcceptInvitation. You should also add AcceptAdministratorInvitation to your policies to ensure that the correct permissions are in place after the console begins to use AcceptAdministratorInvitation. Accepts the invitation to be a member account and be monitored by the Security Hub administrator account that the invitation was sent from. This operation is only used by member accounts that are not added through Organizations. When the member account accepts the invitation, permission is granted to the administrator account to view findings generated in the member account.
- */
- acceptInvitation(callback?: (err: AWSError, data: SecurityHub.Types.AcceptInvitationResponse) => void): Request<SecurityHub.Types.AcceptInvitationResponse, AWSError>;
- /**
- * Deletes one or more automation rules.
- */
- batchDeleteAutomationRules(params: SecurityHub.Types.BatchDeleteAutomationRulesRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchDeleteAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchDeleteAutomationRulesResponse, AWSError>;
- /**
- * Deletes one or more automation rules.
- */
- batchDeleteAutomationRules(callback?: (err: AWSError, data: SecurityHub.Types.BatchDeleteAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchDeleteAutomationRulesResponse, AWSError>;
- /**
- * Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the Security Hub User Guide.
- */
- batchDisableStandards(params: SecurityHub.Types.BatchDisableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request<SecurityHub.Types.BatchDisableStandardsResponse, AWSError>;
- /**
- * Disables the standards specified by the provided StandardsSubscriptionArns. For more information, see Security Standards section of the Security Hub User Guide.
- */
- batchDisableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchDisableStandardsResponse) => void): Request<SecurityHub.Types.BatchDisableStandardsResponse, AWSError>;
- /**
- * Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation. For more information, see the Security Standards section of the Security Hub User Guide.
- */
- batchEnableStandards(params: SecurityHub.Types.BatchEnableStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request<SecurityHub.Types.BatchEnableStandardsResponse, AWSError>;
- /**
- * Enables the standards specified by the provided StandardsArn. To obtain the ARN for a standard, use the DescribeStandards operation. For more information, see the Security Standards section of the Security Hub User Guide.
- */
- batchEnableStandards(callback?: (err: AWSError, data: SecurityHub.Types.BatchEnableStandardsResponse) => void): Request<SecurityHub.Types.BatchEnableStandardsResponse, AWSError>;
- /**
- * Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
- */
- batchGetAutomationRules(params: SecurityHub.Types.BatchGetAutomationRulesRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchGetAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchGetAutomationRulesResponse, AWSError>;
- /**
- * Retrieves a list of details for automation rules based on rule Amazon Resource Names (ARNs).
- */
- batchGetAutomationRules(callback?: (err: AWSError, data: SecurityHub.Types.BatchGetAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchGetAutomationRulesResponse, AWSError>;
- /**
- * Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
- */
- batchGetConfigurationPolicyAssociations(params: SecurityHub.Types.BatchGetConfigurationPolicyAssociationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchGetConfigurationPolicyAssociationsResponse) => void): Request<SecurityHub.Types.BatchGetConfigurationPolicyAssociationsResponse, AWSError>;
- /**
- * Returns associations between an Security Hub configuration and a batch of target accounts, organizational units, or the root. Only the Security Hub delegated administrator can invoke this operation from the home Region. A configuration can refer to a configuration policy or to a self-managed configuration.
- */
- batchGetConfigurationPolicyAssociations(callback?: (err: AWSError, data: SecurityHub.Types.BatchGetConfigurationPolicyAssociationsResponse) => void): Request<SecurityHub.Types.BatchGetConfigurationPolicyAssociationsResponse, AWSError>;
- /**
- * Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
- */
- batchGetSecurityControls(params: SecurityHub.Types.BatchGetSecurityControlsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchGetSecurityControlsResponse) => void): Request<SecurityHub.Types.BatchGetSecurityControlsResponse, AWSError>;
- /**
- * Provides details about a batch of security controls for the current Amazon Web Services account and Amazon Web Services Region.
- */
- batchGetSecurityControls(callback?: (err: AWSError, data: SecurityHub.Types.BatchGetSecurityControlsResponse) => void): Request<SecurityHub.Types.BatchGetSecurityControlsResponse, AWSError>;
- /**
- * For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
- */
- batchGetStandardsControlAssociations(params: SecurityHub.Types.BatchGetStandardsControlAssociationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchGetStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.BatchGetStandardsControlAssociationsResponse, AWSError>;
- /**
- * For a batch of security controls and standards, identifies whether each control is currently enabled or disabled in a standard.
- */
- batchGetStandardsControlAssociations(callback?: (err: AWSError, data: SecurityHub.Types.BatchGetStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.BatchGetStandardsControlAssociationsResponse, AWSError>;
- /**
- * Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub. BatchImportFindings must be called by one of the following: The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding. An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow. Note UserDefinedFields VerificationState Workflow Finding providers also should not use BatchImportFindings to update the following attributes. Confidence Criticality RelatedFindings Severity Types Instead, finding providers use FindingProviderFields to provide values for these attributes.
- */
- batchImportFindings(params: SecurityHub.Types.BatchImportFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request<SecurityHub.Types.BatchImportFindingsResponse, AWSError>;
- /**
- * Imports security findings generated by a finding provider into Security Hub. This action is requested by the finding provider to import its findings into Security Hub. BatchImportFindings must be called by one of the following: The Amazon Web Services account that is associated with a finding if you are using the default product ARN or are a partner sending findings from within a customer's Amazon Web Services account. In these cases, the identifier of the account that you are calling BatchImportFindings from needs to be the same as the AwsAccountId attribute for the finding. An Amazon Web Services account that Security Hub has allow-listed for an official partner integration. In this case, you can call BatchImportFindings from the allow-listed account and send findings from different customer accounts in the same batch. The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb. After a finding is created, BatchImportFindings cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow. Note UserDefinedFields VerificationState Workflow Finding providers also should not use BatchImportFindings to update the following attributes. Confidence Criticality RelatedFindings Severity Types Instead, finding providers use FindingProviderFields to provide values for these attributes.
- */
- batchImportFindings(callback?: (err: AWSError, data: SecurityHub.Types.BatchImportFindingsResponse) => void): Request<SecurityHub.Types.BatchImportFindingsResponse, AWSError>;
- /**
- * Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
- */
- batchUpdateAutomationRules(params: SecurityHub.Types.BatchUpdateAutomationRulesRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchUpdateAutomationRulesResponse, AWSError>;
- /**
- * Updates one or more automation rules based on rule Amazon Resource Names (ARNs) and input parameters.
- */
- batchUpdateAutomationRules(callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateAutomationRulesResponse) => void): Request<SecurityHub.Types.BatchUpdateAutomationRulesResponse, AWSError>;
- /**
- * Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects. Confidence Criticality Note RelatedFindings Severity Types UserDefinedFields VerificationState Workflow You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
- */
- batchUpdateFindings(params: SecurityHub.Types.BatchUpdateFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateFindingsResponse) => void): Request<SecurityHub.Types.BatchUpdateFindingsResponse, AWSError>;
- /**
- * Used by Security Hub customers to update information about their investigation into a finding. Requested by administrator accounts or member accounts. Administrator accounts can update findings for their account and their member accounts. Member accounts can update findings for their account. Updates from BatchUpdateFindings do not affect the value of UpdatedAt for a finding. Administrator and member accounts can use BatchUpdateFindings to update the following finding fields and objects. Confidence Criticality Note RelatedFindings Severity Types UserDefinedFields VerificationState Workflow You can configure IAM policies to restrict access to fields and field values. For example, you might not want member accounts to be able to suppress findings or change the finding severity. See Configuring access to BatchUpdateFindings in the Security Hub User Guide.
- */
- batchUpdateFindings(callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateFindingsResponse) => void): Request<SecurityHub.Types.BatchUpdateFindingsResponse, AWSError>;
- /**
- * For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
- */
- batchUpdateStandardsControlAssociations(params: SecurityHub.Types.BatchUpdateStandardsControlAssociationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.BatchUpdateStandardsControlAssociationsResponse, AWSError>;
- /**
- * For a batch of security controls and standards, this operation updates the enablement status of a control in a standard.
- */
- batchUpdateStandardsControlAssociations(callback?: (err: AWSError, data: SecurityHub.Types.BatchUpdateStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.BatchUpdateStandardsControlAssociationsResponse, AWSError>;
- /**
- * Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
- */
- createActionTarget(params: SecurityHub.Types.CreateActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateActionTargetResponse) => void): Request<SecurityHub.Types.CreateActionTargetResponse, AWSError>;
- /**
- * Creates a custom action target in Security Hub. You can use custom actions on findings and insights in Security Hub to trigger target actions in Amazon CloudWatch Events.
- */
- createActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.CreateActionTargetResponse) => void): Request<SecurityHub.Types.CreateActionTargetResponse, AWSError>;
- /**
- * Creates an automation rule based on input parameters.
- */
- createAutomationRule(params: SecurityHub.Types.CreateAutomationRuleRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateAutomationRuleResponse) => void): Request<SecurityHub.Types.CreateAutomationRuleResponse, AWSError>;
- /**
- * Creates an automation rule based on input parameters.
- */
- createAutomationRule(callback?: (err: AWSError, data: SecurityHub.Types.CreateAutomationRuleResponse) => void): Request<SecurityHub.Types.CreateAutomationRuleResponse, AWSError>;
- /**
- * Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- createConfigurationPolicy(params: SecurityHub.Types.CreateConfigurationPolicyRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateConfigurationPolicyResponse) => void): Request<SecurityHub.Types.CreateConfigurationPolicyResponse, AWSError>;
- /**
- * Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- createConfigurationPolicy(callback?: (err: AWSError, data: SecurityHub.Types.CreateConfigurationPolicyResponse) => void): Request<SecurityHub.Types.CreateConfigurationPolicyResponse, AWSError>;
- /**
- * Used to enable finding aggregation. Must be called from the aggregation Region. For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
- */
- createFindingAggregator(params: SecurityHub.Types.CreateFindingAggregatorRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateFindingAggregatorResponse) => void): Request<SecurityHub.Types.CreateFindingAggregatorResponse, AWSError>;
- /**
- * Used to enable finding aggregation. Must be called from the aggregation Region. For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide.
- */
- createFindingAggregator(callback?: (err: AWSError, data: SecurityHub.Types.CreateFindingAggregatorResponse) => void): Request<SecurityHub.Types.CreateFindingAggregatorResponse, AWSError>;
- /**
- * Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. To group the related findings in the insight, use the GroupByAttribute.
- */
- createInsight(params: SecurityHub.Types.CreateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request<SecurityHub.Types.CreateInsightResponse, AWSError>;
- /**
- * Creates a custom insight in Security Hub. An insight is a consolidation of findings that relate to a security issue that requires attention or remediation. To group the related findings in the insight, use the GroupByAttribute.
- */
- createInsight(callback?: (err: AWSError, data: SecurityHub.Types.CreateInsightResponse) => void): Request<SecurityHub.Types.CreateInsightResponse, AWSError>;
- /**
- * Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account. CreateMembers is always used to add accounts that are not organization members. For accounts that are managed using Organizations, CreateMembers is only used in the following cases: Security Hub is not configured to automatically add new organization accounts. The account was disassociated or deleted in Security Hub. This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation. For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub. Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub. If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account. For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls. A permissions policy is added that permits the administrator account to view the findings generated in the member account. To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
- */
- createMembers(params: SecurityHub.Types.CreateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request<SecurityHub.Types.CreateMembersResponse, AWSError>;
- /**
- * Creates a member association in Security Hub between the specified accounts and the account used to make the request, which is the administrator account. If you are integrated with Organizations, then the administrator account is designated by the organization management account. CreateMembers is always used to add accounts that are not organization members. For accounts that are managed using Organizations, CreateMembers is only used in the following cases: Security Hub is not configured to automatically add new organization accounts. The account was disassociated or deleted in Security Hub. This action can only be used by an account that has Security Hub enabled. To enable Security Hub, you can use the EnableSecurityHub operation. For accounts that are not organization members, you create the account association and then send an invitation to the member account. To send the invitation, you use the InviteMembers operation. If the account owner accepts the invitation, the account becomes a member account in Security Hub. Accounts that are managed using Organizations do not receive an invitation. They automatically become a member account in Security Hub. If the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account. For organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls. A permissions policy is added that permits the administrator account to view the findings generated in the member account. To remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
- */
- createMembers(callback?: (err: AWSError, data: SecurityHub.Types.CreateMembersResponse) => void): Request<SecurityHub.Types.CreateMembersResponse, AWSError>;
- /**
- * Declines invitations to become a member account. A prospective member account uses this operation to decline an invitation to become a member. This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- */
- declineInvitations(params: SecurityHub.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request<SecurityHub.Types.DeclineInvitationsResponse, AWSError>;
- /**
- * Declines invitations to become a member account. A prospective member account uses this operation to decline an invitation to become a member. This operation is only called by member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- */
- declineInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeclineInvitationsResponse) => void): Request<SecurityHub.Types.DeclineInvitationsResponse, AWSError>;
- /**
- * Deletes a custom action target from Security Hub. Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
- */
- deleteActionTarget(params: SecurityHub.Types.DeleteActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteActionTargetResponse) => void): Request<SecurityHub.Types.DeleteActionTargetResponse, AWSError>;
- /**
- * Deletes a custom action target from Security Hub. Deleting a custom action target does not affect any findings or insights that were already sent to Amazon CloudWatch Events using the custom action.
- */
- deleteActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.DeleteActionTargetResponse) => void): Request<SecurityHub.Types.DeleteActionTargetResponse, AWSError>;
- /**
- * Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the StartConfigurationPolicyDisassociation operation.
- */
- deleteConfigurationPolicy(params: SecurityHub.Types.DeleteConfigurationPolicyRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteConfigurationPolicyResponse) => void): Request<SecurityHub.Types.DeleteConfigurationPolicyResponse, AWSError>;
- /**
- * Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts, organizational units, or the root by invoking the StartConfigurationPolicyDisassociation operation.
- */
- deleteConfigurationPolicy(callback?: (err: AWSError, data: SecurityHub.Types.DeleteConfigurationPolicyResponse) => void): Request<SecurityHub.Types.DeleteConfigurationPolicyResponse, AWSError>;
- /**
- * Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation. When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
- */
- deleteFindingAggregator(params: SecurityHub.Types.DeleteFindingAggregatorRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteFindingAggregatorResponse) => void): Request<SecurityHub.Types.DeleteFindingAggregatorResponse, AWSError>;
- /**
- * Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation. When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
- */
- deleteFindingAggregator(callback?: (err: AWSError, data: SecurityHub.Types.DeleteFindingAggregatorResponse) => void): Request<SecurityHub.Types.DeleteFindingAggregatorResponse, AWSError>;
- /**
- * Deletes the insight specified by the InsightArn.
- */
- deleteInsight(params: SecurityHub.Types.DeleteInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request<SecurityHub.Types.DeleteInsightResponse, AWSError>;
- /**
- * Deletes the insight specified by the InsightArn.
- */
- deleteInsight(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInsightResponse) => void): Request<SecurityHub.Types.DeleteInsightResponse, AWSError>;
- /**
- * Deletes invitations received by the Amazon Web Services account to become a member account. A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts. This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- */
- deleteInvitations(params: SecurityHub.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request<SecurityHub.Types.DeleteInvitationsResponse, AWSError>;
- /**
- * Deletes invitations received by the Amazon Web Services account to become a member account. A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts. This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization. Organization accounts don't receive invitations.
- */
- deleteInvitations(callback?: (err: AWSError, data: SecurityHub.Types.DeleteInvitationsResponse) => void): Request<SecurityHub.Types.DeleteInvitationsResponse, AWSError>;
- /**
- * Deletes the specified member accounts from Security Hub. You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.
- */
- deleteMembers(params: SecurityHub.Types.DeleteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request<SecurityHub.Types.DeleteMembersResponse, AWSError>;
- /**
- * Deletes the specified member accounts from Security Hub. You can invoke this API only to delete accounts that became members through invitation. You can't invoke this API to delete accounts that belong to an Organizations organization.
- */
- deleteMembers(callback?: (err: AWSError, data: SecurityHub.Types.DeleteMembersResponse) => void): Request<SecurityHub.Types.DeleteMembersResponse, AWSError>;
- /**
- * Returns a list of the custom action targets in Security Hub in your account.
- */
- describeActionTargets(params: SecurityHub.Types.DescribeActionTargetsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeActionTargetsResponse) => void): Request<SecurityHub.Types.DescribeActionTargetsResponse, AWSError>;
- /**
- * Returns a list of the custom action targets in Security Hub in your account.
- */
- describeActionTargets(callback?: (err: AWSError, data: SecurityHub.Types.DescribeActionTargetsResponse) => void): Request<SecurityHub.Types.DescribeActionTargetsResponse, AWSError>;
- /**
- * Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
- */
- describeHub(params: SecurityHub.Types.DescribeHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeHubResponse) => void): Request<SecurityHub.Types.DescribeHubResponse, AWSError>;
- /**
- * Returns details about the Hub resource in your account, including the HubArn and the time when you enabled Security Hub.
- */
- describeHub(callback?: (err: AWSError, data: SecurityHub.Types.DescribeHubResponse) => void): Request<SecurityHub.Types.DescribeHubResponse, AWSError>;
- /**
- * Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
- */
- describeOrganizationConfiguration(params: SecurityHub.Types.DescribeOrganizationConfigurationRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeOrganizationConfigurationResponse) => void): Request<SecurityHub.Types.DescribeOrganizationConfigurationResponse, AWSError>;
- /**
- * Returns information about the way your organization is configured in Security Hub. Only the Security Hub administrator account can invoke this operation.
- */
- describeOrganizationConfiguration(callback?: (err: AWSError, data: SecurityHub.Types.DescribeOrganizationConfigurationResponse) => void): Request<SecurityHub.Types.DescribeOrganizationConfigurationResponse, AWSError>;
- /**
- * Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations.
- */
- describeProducts(params: SecurityHub.Types.DescribeProductsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeProductsResponse) => void): Request<SecurityHub.Types.DescribeProductsResponse, AWSError>;
- /**
- * Returns information about product integrations in Security Hub. You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration. If you do not provide an integration ARN, then the results include all of the available product integrations.
- */
- describeProducts(callback?: (err: AWSError, data: SecurityHub.Types.DescribeProductsResponse) => void): Request<SecurityHub.Types.DescribeProductsResponse, AWSError>;
- /**
- * Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.
- */
- describeStandards(params: SecurityHub.Types.DescribeStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeStandardsResponse) => void): Request<SecurityHub.Types.DescribeStandardsResponse, AWSError>;
- /**
- * Returns a list of the available standards in Security Hub. For each standard, the results include the standard ARN, the name, and a description.
- */
- describeStandards(callback?: (err: AWSError, data: SecurityHub.Types.DescribeStandardsResponse) => void): Request<SecurityHub.Types.DescribeStandardsResponse, AWSError>;
- /**
- * Returns a list of security standards controls. For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
- */
- describeStandardsControls(params: SecurityHub.Types.DescribeStandardsControlsRequest, callback?: (err: AWSError, data: SecurityHub.Types.DescribeStandardsControlsResponse) => void): Request<SecurityHub.Types.DescribeStandardsControlsResponse, AWSError>;
- /**
- * Returns a list of security standards controls. For each control, the results include information about whether it is currently enabled, the severity, and a link to remediation information.
- */
- describeStandardsControls(callback?: (err: AWSError, data: SecurityHub.Types.DescribeStandardsControlsResponse) => void): Request<SecurityHub.Types.DescribeStandardsControlsResponse, AWSError>;
- /**
- * Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.
- */
- disableImportFindingsForProduct(params: SecurityHub.Types.DisableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.DisableImportFindingsForProductResponse, AWSError>;
- /**
- * Disables the integration of the specified product with Security Hub. After the integration is disabled, findings from that product are no longer sent to Security Hub.
- */
- disableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.DisableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.DisableImportFindingsForProductResponse, AWSError>;
- /**
- * Disables a Security Hub administrator account. Can only be called by the organization management account.
- */
- disableOrganizationAdminAccount(params: SecurityHub.Types.DisableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableOrganizationAdminAccountResponse) => void): Request<SecurityHub.Types.DisableOrganizationAdminAccountResponse, AWSError>;
- /**
- * Disables a Security Hub administrator account. Can only be called by the organization management account.
- */
- disableOrganizationAdminAccount(callback?: (err: AWSError, data: SecurityHub.Types.DisableOrganizationAdminAccountResponse) => void): Request<SecurityHub.Types.DisableOrganizationAdminAccountResponse, AWSError>;
- /**
- * Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. You can't disable Security Hub in an account that is currently the Security Hub administrator. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
- */
- disableSecurityHub(params: SecurityHub.Types.DisableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request<SecurityHub.Types.DisableSecurityHubResponse, AWSError>;
- /**
- * Disables Security Hub in your account only in the current Amazon Web Services Region. To disable Security Hub in all Regions, you must submit one request per Region where you have enabled Security Hub. You can't disable Security Hub in an account that is currently the Security Hub administrator. When you disable Security Hub, your existing findings and insights and any Security Hub configuration settings are deleted after 90 days and cannot be recovered. Any standards that were enabled are disabled, and your administrator and member account associations are removed. If you want to save your existing findings, you must export them before you disable Security Hub.
- */
- disableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.DisableSecurityHubResponse) => void): Request<SecurityHub.Types.DisableSecurityHubResponse, AWSError>;
- /**
- * Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- */
- disassociateFromAdministratorAccount(params: SecurityHub.Types.DisassociateFromAdministratorAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromAdministratorAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromAdministratorAccountResponse, AWSError>;
- /**
- * Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- */
- disassociateFromAdministratorAccount(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromAdministratorAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromAdministratorAccountResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use DisassociateFromAdministratorAccount. The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount. Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- */
- disassociateFromMasterAccount(params: SecurityHub.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromMasterAccountResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use DisassociateFromAdministratorAccount. The Security Hub console continues to use DisassociateFromMasterAccount. It will eventually change to use DisassociateFromAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use DisassociateFromMasterAccount. You should also add DisassociateFromAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use DisassociateFromAdministratorAccount. Disassociates the current Security Hub member account from the associated administrator account. This operation is only used by accounts that are not part of an organization. For organization accounts, only the administrator account can disassociate a member account.
- */
- disassociateFromMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateFromMasterAccountResponse) => void): Request<SecurityHub.Types.DisassociateFromMasterAccountResponse, AWSError>;
- /**
- * Disassociates the specified member accounts from the associated administrator account. Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
- */
- disassociateMembers(params: SecurityHub.Types.DisassociateMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request<SecurityHub.Types.DisassociateMembersResponse, AWSError>;
- /**
- * Disassociates the specified member accounts from the associated administrator account. Can be used to disassociate both accounts that are managed using Organizations and accounts that were invited manually.
- */
- disassociateMembers(callback?: (err: AWSError, data: SecurityHub.Types.DisassociateMembersResponse) => void): Request<SecurityHub.Types.DisassociateMembersResponse, AWSError>;
- /**
- * Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.
- */
- enableImportFindingsForProduct(params: SecurityHub.Types.EnableImportFindingsForProductRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.EnableImportFindingsForProductResponse, AWSError>;
- /**
- * Enables the integration of a partner product with Security Hub. Integrated products send findings to Security Hub. When you enable a product integration, a permissions policy that grants permission for the product to send findings to Security Hub is applied.
- */
- enableImportFindingsForProduct(callback?: (err: AWSError, data: SecurityHub.Types.EnableImportFindingsForProductResponse) => void): Request<SecurityHub.Types.EnableImportFindingsForProductResponse, AWSError>;
- /**
- * Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
- */
- enableOrganizationAdminAccount(params: SecurityHub.Types.EnableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableOrganizationAdminAccountResponse) => void): Request<SecurityHub.Types.EnableOrganizationAdminAccountResponse, AWSError>;
- /**
- * Designates the Security Hub administrator account for an organization. Can only be called by the organization management account.
- */
- enableOrganizationAdminAccount(callback?: (err: AWSError, data: SecurityHub.Types.EnableOrganizationAdminAccountResponse) => void): Request<SecurityHub.Types.EnableOrganizationAdminAccountResponse, AWSError>;
- /**
- * Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub. When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards: Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0 Amazon Web Services Foundational Security Best Practices Other standards are not automatically enabled. To opt out of automatically enabled standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation. To learn more, see the setup information in the Security Hub User Guide.
- */
- enableSecurityHub(params: SecurityHub.Types.EnableSecurityHubRequest, callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request<SecurityHub.Types.EnableSecurityHubResponse, AWSError>;
- /**
- * Enables Security Hub for your account in the current Region or the Region you specify in the request. When you enable Security Hub, you grant to Security Hub the permissions necessary to gather findings from other services that are integrated with Security Hub. When you use the EnableSecurityHub operation to enable Security Hub, you also automatically enable the following standards: Center for Internet Security (CIS) Amazon Web Services Foundations Benchmark v1.2.0 Amazon Web Services Foundational Security Best Practices Other standards are not automatically enabled. To opt out of automatically enabled standards, set EnableDefaultStandards to false. After you enable Security Hub, to enable a standard, use the BatchEnableStandards operation. To disable a standard, use the BatchDisableStandards operation. To learn more, see the setup information in the Security Hub User Guide.
- */
- enableSecurityHub(callback?: (err: AWSError, data: SecurityHub.Types.EnableSecurityHubResponse) => void): Request<SecurityHub.Types.EnableSecurityHubResponse, AWSError>;
- /**
- * Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getAdministratorAccount(params: SecurityHub.Types.GetAdministratorAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetAdministratorAccountResponse) => void): Request<SecurityHub.Types.GetAdministratorAccountResponse, AWSError>;
- /**
- * Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getAdministratorAccount(callback?: (err: AWSError, data: SecurityHub.Types.GetAdministratorAccountResponse) => void): Request<SecurityHub.Types.GetAdministratorAccountResponse, AWSError>;
- /**
- * Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- getConfigurationPolicy(params: SecurityHub.Types.GetConfigurationPolicyRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetConfigurationPolicyResponse) => void): Request<SecurityHub.Types.GetConfigurationPolicyResponse, AWSError>;
- /**
- * Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- getConfigurationPolicy(callback?: (err: AWSError, data: SecurityHub.Types.GetConfigurationPolicyResponse) => void): Request<SecurityHub.Types.GetConfigurationPolicyResponse, AWSError>;
- /**
- * Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- getConfigurationPolicyAssociation(params: SecurityHub.Types.GetConfigurationPolicyAssociationRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetConfigurationPolicyAssociationResponse) => void): Request<SecurityHub.Types.GetConfigurationPolicyAssociationResponse, AWSError>;
- /**
- * Returns the association between a configuration and a target account, organizational unit, or the root. The configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- getConfigurationPolicyAssociation(callback?: (err: AWSError, data: SecurityHub.Types.GetConfigurationPolicyAssociationResponse) => void): Request<SecurityHub.Types.GetConfigurationPolicyAssociationResponse, AWSError>;
- /**
- * Returns a list of the standards that are currently enabled.
- */
- getEnabledStandards(params: SecurityHub.Types.GetEnabledStandardsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request<SecurityHub.Types.GetEnabledStandardsResponse, AWSError>;
- /**
- * Returns a list of the standards that are currently enabled.
- */
- getEnabledStandards(callback?: (err: AWSError, data: SecurityHub.Types.GetEnabledStandardsResponse) => void): Request<SecurityHub.Types.GetEnabledStandardsResponse, AWSError>;
- /**
- * Returns the current finding aggregation configuration.
- */
- getFindingAggregator(params: SecurityHub.Types.GetFindingAggregatorRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetFindingAggregatorResponse) => void): Request<SecurityHub.Types.GetFindingAggregatorResponse, AWSError>;
- /**
- * Returns the current finding aggregation configuration.
- */
- getFindingAggregator(callback?: (err: AWSError, data: SecurityHub.Types.GetFindingAggregatorResponse) => void): Request<SecurityHub.Types.GetFindingAggregatorResponse, AWSError>;
- /**
- * Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
- */
- getFindingHistory(params: SecurityHub.Types.GetFindingHistoryRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetFindingHistoryResponse) => void): Request<SecurityHub.Types.GetFindingHistoryResponse, AWSError>;
- /**
- * Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in the Amazon Web Services Security Finding Format (ASFF).
- */
- getFindingHistory(callback?: (err: AWSError, data: SecurityHub.Types.GetFindingHistoryResponse) => void): Request<SecurityHub.Types.GetFindingHistoryResponse, AWSError>;
- /**
- * Returns a list of findings that match the specified criteria. If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
- */
- getFindings(params: SecurityHub.Types.GetFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request<SecurityHub.Types.GetFindingsResponse, AWSError>;
- /**
- * Returns a list of findings that match the specified criteria. If finding aggregation is enabled, then when you call GetFindings from the aggregation Region, the results include all of the matching findings from both the aggregation Region and the linked Regions.
- */
- getFindings(callback?: (err: AWSError, data: SecurityHub.Types.GetFindingsResponse) => void): Request<SecurityHub.Types.GetFindingsResponse, AWSError>;
- /**
- * Lists the results of the Security Hub insight specified by the insight ARN.
- */
- getInsightResults(params: SecurityHub.Types.GetInsightResultsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request<SecurityHub.Types.GetInsightResultsResponse, AWSError>;
- /**
- * Lists the results of the Security Hub insight specified by the insight ARN.
- */
- getInsightResults(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightResultsResponse) => void): Request<SecurityHub.Types.GetInsightResultsResponse, AWSError>;
- /**
- * Lists and describes insights for the specified insight ARNs.
- */
- getInsights(params: SecurityHub.Types.GetInsightsRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request<SecurityHub.Types.GetInsightsResponse, AWSError>;
- /**
- * Lists and describes insights for the specified insight ARNs.
- */
- getInsights(callback?: (err: AWSError, data: SecurityHub.Types.GetInsightsResponse) => void): Request<SecurityHub.Types.GetInsightsResponse, AWSError>;
- /**
- * Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
- */
- getInvitationsCount(params: SecurityHub.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request<SecurityHub.Types.GetInvitationsCountResponse, AWSError>;
- /**
- * Returns the count of all Security Hub membership invitations that were sent to the current member account, not including the currently accepted invitation.
- */
- getInvitationsCount(callback?: (err: AWSError, data: SecurityHub.Types.GetInvitationsCountResponse) => void): Request<SecurityHub.Types.GetInvitationsCountResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use GetAdministratorAccount. The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount. Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getMasterAccount(params: SecurityHub.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request<SecurityHub.Types.GetMasterAccountResponse, AWSError>;
- /**
- * This method is deprecated. Instead, use GetAdministratorAccount. The Security Hub console continues to use GetMasterAccount. It will eventually change to use GetAdministratorAccount. Any IAM policies that specifically control access to this function must continue to use GetMasterAccount. You should also add GetAdministratorAccount to your policies to ensure that the correct permissions are in place after the console begins to use GetAdministratorAccount. Provides the details for the Security Hub administrator account for the current member account. Can be used by both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getMasterAccount(callback?: (err: AWSError, data: SecurityHub.Types.GetMasterAccountResponse) => void): Request<SecurityHub.Types.GetMasterAccountResponse, AWSError>;
- /**
- * Returns the details for the Security Hub member accounts for the specified account IDs. An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The results include both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getMembers(params: SecurityHub.Types.GetMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request<SecurityHub.Types.GetMembersResponse, AWSError>;
- /**
- * Returns the details for the Security Hub member accounts for the specified account IDs. An administrator account can be either the delegated Security Hub administrator account for an organization or an administrator account that enabled Security Hub manually. The results include both member accounts that are managed using Organizations and accounts that were invited manually.
- */
- getMembers(callback?: (err: AWSError, data: SecurityHub.Types.GetMembersResponse) => void): Request<SecurityHub.Types.GetMembersResponse, AWSError>;
- /**
- * Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
- */
- getSecurityControlDefinition(params: SecurityHub.Types.GetSecurityControlDefinitionRequest, callback?: (err: AWSError, data: SecurityHub.Types.GetSecurityControlDefinitionResponse) => void): Request<SecurityHub.Types.GetSecurityControlDefinitionResponse, AWSError>;
- /**
- * Retrieves the definition of a security control. The definition includes the control title, description, Region availability, parameter definitions, and other details.
- */
- getSecurityControlDefinition(callback?: (err: AWSError, data: SecurityHub.Types.GetSecurityControlDefinitionResponse) => void): Request<SecurityHub.Types.GetSecurityControlDefinitionResponse, AWSError>;
- /**
- * Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from. This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations. Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub. When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
- */
- inviteMembers(params: SecurityHub.Types.InviteMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request<SecurityHub.Types.InviteMembersResponse, AWSError>;
- /**
- * Invites other Amazon Web Services accounts to become member accounts for the Security Hub administrator account that the invitation is sent from. This operation is only used to invite accounts that do not belong to an organization. Organization accounts do not receive invitations. Before you can use this action to invite a member, you must first use the CreateMembers action to create the member account in Security Hub. When the account owner enables Security Hub and accepts the invitation to become a member account, the administrator account can view the findings generated from the member account.
- */
- inviteMembers(callback?: (err: AWSError, data: SecurityHub.Types.InviteMembersResponse) => void): Request<SecurityHub.Types.InviteMembersResponse, AWSError>;
- /**
- * A list of automation rules and their metadata for the calling account.
- */
- listAutomationRules(params: SecurityHub.Types.ListAutomationRulesRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListAutomationRulesResponse) => void): Request<SecurityHub.Types.ListAutomationRulesResponse, AWSError>;
- /**
- * A list of automation rules and their metadata for the calling account.
- */
- listAutomationRules(callback?: (err: AWSError, data: SecurityHub.Types.ListAutomationRulesResponse) => void): Request<SecurityHub.Types.ListAutomationRulesResponse, AWSError>;
- /**
- * Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
- */
- listConfigurationPolicies(params: SecurityHub.Types.ListConfigurationPoliciesRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListConfigurationPoliciesResponse) => void): Request<SecurityHub.Types.ListConfigurationPoliciesResponse, AWSError>;
- /**
- * Lists the configuration policies that the Security Hub delegated administrator has created for your organization. Only the delegated administrator can invoke this operation from the home Region.
- */
- listConfigurationPolicies(callback?: (err: AWSError, data: SecurityHub.Types.ListConfigurationPoliciesResponse) => void): Request<SecurityHub.Types.ListConfigurationPoliciesResponse, AWSError>;
- /**
- * Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- listConfigurationPolicyAssociations(params: SecurityHub.Types.ListConfigurationPolicyAssociationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListConfigurationPolicyAssociationsResponse) => void): Request<SecurityHub.Types.ListConfigurationPolicyAssociationsResponse, AWSError>;
- /**
- * Provides information about the associations for your configuration policies and self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- listConfigurationPolicyAssociations(callback?: (err: AWSError, data: SecurityHub.Types.ListConfigurationPolicyAssociationsResponse) => void): Request<SecurityHub.Types.ListConfigurationPolicyAssociationsResponse, AWSError>;
- /**
- * Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- */
- listEnabledProductsForImport(params: SecurityHub.Types.ListEnabledProductsForImportRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request<SecurityHub.Types.ListEnabledProductsForImportResponse, AWSError>;
- /**
- * Lists all findings-generating solutions (products) that you are subscribed to receive findings from in Security Hub.
- */
- listEnabledProductsForImport(callback?: (err: AWSError, data: SecurityHub.Types.ListEnabledProductsForImportResponse) => void): Request<SecurityHub.Types.ListEnabledProductsForImportResponse, AWSError>;
- /**
- * If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
- */
- listFindingAggregators(params: SecurityHub.Types.ListFindingAggregatorsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListFindingAggregatorsResponse) => void): Request<SecurityHub.Types.ListFindingAggregatorsResponse, AWSError>;
- /**
- * If finding aggregation is enabled, then ListFindingAggregators returns the ARN of the finding aggregator. You can run this operation from any Region.
- */
- listFindingAggregators(callback?: (err: AWSError, data: SecurityHub.Types.ListFindingAggregatorsResponse) => void): Request<SecurityHub.Types.ListFindingAggregatorsResponse, AWSError>;
- /**
- * Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account. This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
- */
- listInvitations(params: SecurityHub.Types.ListInvitationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request<SecurityHub.Types.ListInvitationsResponse, AWSError>;
- /**
- * Lists all Security Hub membership invitations that were sent to the current Amazon Web Services account. This operation is only used by accounts that are managed by invitation. Accounts that are managed using the integration with Organizations do not receive invitations.
- */
- listInvitations(callback?: (err: AWSError, data: SecurityHub.Types.ListInvitationsResponse) => void): Request<SecurityHub.Types.ListInvitationsResponse, AWSError>;
- /**
- * Lists details about all member accounts for the current Security Hub administrator account. The results include both member accounts that belong to an organization and member accounts that were invited manually.
- */
- listMembers(params: SecurityHub.Types.ListMembersRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request<SecurityHub.Types.ListMembersResponse, AWSError>;
- /**
- * Lists details about all member accounts for the current Security Hub administrator account. The results include both member accounts that belong to an organization and member accounts that were invited manually.
- */
- listMembers(callback?: (err: AWSError, data: SecurityHub.Types.ListMembersResponse) => void): Request<SecurityHub.Types.ListMembersResponse, AWSError>;
- /**
- * Lists the Security Hub administrator accounts. Can only be called by the organization management account.
- */
- listOrganizationAdminAccounts(params: SecurityHub.Types.ListOrganizationAdminAccountsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListOrganizationAdminAccountsResponse) => void): Request<SecurityHub.Types.ListOrganizationAdminAccountsResponse, AWSError>;
- /**
- * Lists the Security Hub administrator accounts. Can only be called by the organization management account.
- */
- listOrganizationAdminAccounts(callback?: (err: AWSError, data: SecurityHub.Types.ListOrganizationAdminAccountsResponse) => void): Request<SecurityHub.Types.ListOrganizationAdminAccountsResponse, AWSError>;
- /**
- * Lists all of the security controls that apply to a specified standard.
- */
- listSecurityControlDefinitions(params: SecurityHub.Types.ListSecurityControlDefinitionsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListSecurityControlDefinitionsResponse) => void): Request<SecurityHub.Types.ListSecurityControlDefinitionsResponse, AWSError>;
- /**
- * Lists all of the security controls that apply to a specified standard.
- */
- listSecurityControlDefinitions(callback?: (err: AWSError, data: SecurityHub.Types.ListSecurityControlDefinitionsResponse) => void): Request<SecurityHub.Types.ListSecurityControlDefinitionsResponse, AWSError>;
- /**
- * Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
- */
- listStandardsControlAssociations(params: SecurityHub.Types.ListStandardsControlAssociationsRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.ListStandardsControlAssociationsResponse, AWSError>;
- /**
- * Specifies whether a control is currently enabled or disabled in each enabled standard in the calling account.
- */
- listStandardsControlAssociations(callback?: (err: AWSError, data: SecurityHub.Types.ListStandardsControlAssociationsResponse) => void): Request<SecurityHub.Types.ListStandardsControlAssociationsResponse, AWSError>;
- /**
- * Returns a list of tags associated with a resource.
- */
- listTagsForResource(params: SecurityHub.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.ListTagsForResourceResponse) => void): Request<SecurityHub.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Returns a list of tags associated with a resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: SecurityHub.Types.ListTagsForResourceResponse) => void): Request<SecurityHub.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- startConfigurationPolicyAssociation(params: SecurityHub.Types.StartConfigurationPolicyAssociationRequest, callback?: (err: AWSError, data: SecurityHub.Types.StartConfigurationPolicyAssociationResponse) => void): Request<SecurityHub.Types.StartConfigurationPolicyAssociationResponse, AWSError>;
- /**
- * Associates a target account, organizational unit, or the root with a specified configuration. The target can be associated with a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- startConfigurationPolicyAssociation(callback?: (err: AWSError, data: SecurityHub.Types.StartConfigurationPolicyAssociationResponse) => void): Request<SecurityHub.Types.StartConfigurationPolicyAssociationResponse, AWSError>;
- /**
- * Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- startConfigurationPolicyDisassociation(params: SecurityHub.Types.StartConfigurationPolicyDisassociationRequest, callback?: (err: AWSError, data: SecurityHub.Types.StartConfigurationPolicyDisassociationResponse) => void): Request<SecurityHub.Types.StartConfigurationPolicyDisassociationResponse, AWSError>;
- /**
- * Disassociates a target account, organizational unit, or the root from a specified configuration. When you disassociate a configuration from its target, the target inherits the configuration of the closest parent. If there’s no configuration to inherit, the target retains its settings but becomes a self-managed account. A target can be disassociated from a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- startConfigurationPolicyDisassociation(callback?: (err: AWSError, data: SecurityHub.Types.StartConfigurationPolicyDisassociationResponse) => void): Request<SecurityHub.Types.StartConfigurationPolicyDisassociationResponse, AWSError>;
- /**
- * Adds one or more tags to a resource.
- */
- tagResource(params: SecurityHub.Types.TagResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.TagResourceResponse) => void): Request<SecurityHub.Types.TagResourceResponse, AWSError>;
- /**
- * Adds one or more tags to a resource.
- */
- tagResource(callback?: (err: AWSError, data: SecurityHub.Types.TagResourceResponse) => void): Request<SecurityHub.Types.TagResourceResponse, AWSError>;
- /**
- * Removes one or more tags from a resource.
- */
- untagResource(params: SecurityHub.Types.UntagResourceRequest, callback?: (err: AWSError, data: SecurityHub.Types.UntagResourceResponse) => void): Request<SecurityHub.Types.UntagResourceResponse, AWSError>;
- /**
- * Removes one or more tags from a resource.
- */
- untagResource(callback?: (err: AWSError, data: SecurityHub.Types.UntagResourceResponse) => void): Request<SecurityHub.Types.UntagResourceResponse, AWSError>;
- /**
- * Updates the name and description of a custom action target in Security Hub.
- */
- updateActionTarget(params: SecurityHub.Types.UpdateActionTargetRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateActionTargetResponse) => void): Request<SecurityHub.Types.UpdateActionTargetResponse, AWSError>;
- /**
- * Updates the name and description of a custom action target in Security Hub.
- */
- updateActionTarget(callback?: (err: AWSError, data: SecurityHub.Types.UpdateActionTargetResponse) => void): Request<SecurityHub.Types.UpdateActionTargetResponse, AWSError>;
- /**
- * Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- updateConfigurationPolicy(params: SecurityHub.Types.UpdateConfigurationPolicyRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateConfigurationPolicyResponse) => void): Request<SecurityHub.Types.UpdateConfigurationPolicyResponse, AWSError>;
- /**
- * Updates a configuration policy. Only the Security Hub delegated administrator can invoke this operation from the home Region.
- */
- updateConfigurationPolicy(callback?: (err: AWSError, data: SecurityHub.Types.UpdateConfigurationPolicyResponse) => void): Request<SecurityHub.Types.UpdateConfigurationPolicyResponse, AWSError>;
- /**
- * Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region. You must run UpdateFindingAggregator from the current aggregation Region.
- */
- updateFindingAggregator(params: SecurityHub.Types.UpdateFindingAggregatorRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingAggregatorResponse) => void): Request<SecurityHub.Types.UpdateFindingAggregatorResponse, AWSError>;
- /**
- * Updates the finding aggregation configuration. Used to update the Region linking mode and the list of included or excluded Regions. You cannot use UpdateFindingAggregator to change the aggregation Region. You must run UpdateFindingAggregator from the current aggregation Region.
- */
- updateFindingAggregator(callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingAggregatorResponse) => void): Request<SecurityHub.Types.UpdateFindingAggregatorResponse, AWSError>;
- /**
- * UpdateFindings is a deprecated operation. Instead of UpdateFindings, use the BatchUpdateFindings operation. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding. Finding updates made with UpdateFindings might not be persisted if the same finding is later updated by the finding provider through the BatchImportFindings operation.
- */
- updateFindings(params: SecurityHub.Types.UpdateFindingsRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request<SecurityHub.Types.UpdateFindingsResponse, AWSError>;
- /**
- * UpdateFindings is a deprecated operation. Instead of UpdateFindings, use the BatchUpdateFindings operation. Updates the Note and RecordState of the Security Hub-aggregated findings that the filter attributes specify. Any member account that can view the finding also sees the update to the finding. Finding updates made with UpdateFindings might not be persisted if the same finding is later updated by the finding provider through the BatchImportFindings operation.
- */
- updateFindings(callback?: (err: AWSError, data: SecurityHub.Types.UpdateFindingsResponse) => void): Request<SecurityHub.Types.UpdateFindingsResponse, AWSError>;
- /**
- * Updates the Security Hub insight identified by the specified insight ARN.
- */
- updateInsight(params: SecurityHub.Types.UpdateInsightRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request<SecurityHub.Types.UpdateInsightResponse, AWSError>;
- /**
- * Updates the Security Hub insight identified by the specified insight ARN.
- */
- updateInsight(callback?: (err: AWSError, data: SecurityHub.Types.UpdateInsightResponse) => void): Request<SecurityHub.Types.UpdateInsightResponse, AWSError>;
- /**
- * Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
- */
- updateOrganizationConfiguration(params: SecurityHub.Types.UpdateOrganizationConfigurationRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateOrganizationConfigurationResponse) => void): Request<SecurityHub.Types.UpdateOrganizationConfigurationResponse, AWSError>;
- /**
- * Updates the configuration of your organization in Security Hub. Only the Security Hub administrator account can invoke this operation.
- */
- updateOrganizationConfiguration(callback?: (err: AWSError, data: SecurityHub.Types.UpdateOrganizationConfigurationResponse) => void): Request<SecurityHub.Types.UpdateOrganizationConfigurationResponse, AWSError>;
- /**
- * Updates the properties of a security control.
- */
- updateSecurityControl(params: SecurityHub.Types.UpdateSecurityControlRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateSecurityControlResponse) => void): Request<SecurityHub.Types.UpdateSecurityControlResponse, AWSError>;
- /**
- * Updates the properties of a security control.
- */
- updateSecurityControl(callback?: (err: AWSError, data: SecurityHub.Types.UpdateSecurityControlResponse) => void): Request<SecurityHub.Types.UpdateSecurityControlResponse, AWSError>;
- /**
- * Updates configuration options for Security Hub.
- */
- updateSecurityHubConfiguration(params: SecurityHub.Types.UpdateSecurityHubConfigurationRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateSecurityHubConfigurationResponse) => void): Request<SecurityHub.Types.UpdateSecurityHubConfigurationResponse, AWSError>;
- /**
- * Updates configuration options for Security Hub.
- */
- updateSecurityHubConfiguration(callback?: (err: AWSError, data: SecurityHub.Types.UpdateSecurityHubConfigurationResponse) => void): Request<SecurityHub.Types.UpdateSecurityHubConfigurationResponse, AWSError>;
- /**
- * Used to control whether an individual security standard control is enabled or disabled.
- */
- updateStandardsControl(params: SecurityHub.Types.UpdateStandardsControlRequest, callback?: (err: AWSError, data: SecurityHub.Types.UpdateStandardsControlResponse) => void): Request<SecurityHub.Types.UpdateStandardsControlResponse, AWSError>;
- /**
- * Used to control whether an individual security standard control is enabled or disabled.
- */
- updateStandardsControl(callback?: (err: AWSError, data: SecurityHub.Types.UpdateStandardsControlResponse) => void): Request<SecurityHub.Types.UpdateStandardsControlResponse, AWSError>;
- }
- declare namespace SecurityHub {
- export interface AcceptAdministratorInvitationRequest {
- /**
- * The account ID of the Security Hub administrator account that sent the invitation.
- */
- AdministratorId: NonEmptyString;
- /**
- * The identifier of the invitation sent from the Security Hub administrator account.
- */
- InvitationId: NonEmptyString;
- }
- export interface AcceptAdministratorInvitationResponse {
- }
- export interface AcceptInvitationRequest {
- /**
- * The account ID of the Security Hub administrator account that sent the invitation.
- */
- MasterId: NonEmptyString;
- /**
- * The identifier of the invitation sent from the Security Hub administrator account.
- */
- InvitationId: NonEmptyString;
- }
- export interface AcceptInvitationResponse {
- }
- export interface AccountDetails {
- /**
- * The ID of an Amazon Web Services account.
- */
- AccountId: AccountId;
- /**
- * The email of an Amazon Web Services account.
- */
- Email?: NonEmptyString;
- }
- export type AccountDetailsList = AccountDetails[];
- export type AccountId = string;
- export type AccountIdList = NonEmptyString[];
- export interface Action {
- /**
- * The type of action that was detected. The possible action types are: NETWORK_CONNECTION AWS_API_CALL DNS_REQUEST PORT_PROBE
- */
- ActionType?: NonEmptyString;
- /**
- * Included if ActionType is NETWORK_CONNECTION. Provides details about the network connection that was detected.
- */
- NetworkConnectionAction?: NetworkConnectionAction;
- /**
- * Included if ActionType is AWS_API_CALL. Provides details about the API call that was detected.
- */
- AwsApiCallAction?: AwsApiCallAction;
- /**
- * Included if ActionType is DNS_REQUEST. Provides details about the DNS request that was detected.
- */
- DnsRequestAction?: DnsRequestAction;
- /**
- * Included if ActionType is PORT_PROBE. Provides details about the port probe that was detected.
- */
- PortProbeAction?: PortProbeAction;
- }
- export type ActionList = AutomationRulesAction[];
- export interface ActionLocalIpDetails {
- /**
- * The IP address.
- */
- IpAddressV4?: NonEmptyString;
- }
- export interface ActionLocalPortDetails {
- /**
- * The number of the port.
- */
- Port?: Integer;
- /**
- * The port name of the local connection.
- */
- PortName?: NonEmptyString;
- }
- export interface ActionRemoteIpDetails {
- /**
- * The IP address.
- */
- IpAddressV4?: NonEmptyString;
- /**
- * The internet service provider (ISP) organization associated with the remote IP address.
- */
- Organization?: IpOrganizationDetails;
- /**
- * The country where the remote IP address is located.
- */
- Country?: Country;
- /**
- * The city where the remote IP address is located.
- */
- City?: City;
- /**
- * The coordinates of the location of the remote IP address.
- */
- GeoLocation?: GeoLocation;
- }
- export interface ActionRemotePortDetails {
- /**
- * The number of the port.
- */
- Port?: Integer;
- /**
- * The port name of the remote connection.
- */
- PortName?: NonEmptyString;
- }
- export interface ActionTarget {
- /**
- * The ARN for the target action.
- */
- ActionTargetArn: NonEmptyString;
- /**
- * The name of the action target.
- */
- Name: NonEmptyString;
- /**
- * The description of the target action.
- */
- Description: NonEmptyString;
- }
- export type ActionTargetList = ActionTarget[];
- export interface Adjustment {
- /**
- * The metric to adjust.
- */
- Metric?: NonEmptyString;
- /**
- * The reason for the adjustment.
- */
- Reason?: NonEmptyString;
- }
- export type AdjustmentList = Adjustment[];
- export interface AdminAccount {
- /**
- * The Amazon Web Services account identifier of the Security Hub administrator account.
- */
- AccountId?: NonEmptyString;
- /**
- * The current status of the Security Hub administrator account. Indicates whether the account is currently enabled as a Security Hub administrator.
- */
- Status?: AdminStatus;
- }
- export type AdminAccounts = AdminAccount[];
- export type AdminStatus = "ENABLED"|"DISABLE_IN_PROGRESS"|string;
- export type AdminsMaxResults = number;
- export type AlphaNumericNonEmptyString = string;
- export type ArnList = NonEmptyString[];
- export interface AssociatedStandard {
- /**
- * The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
- */
- StandardsId?: NonEmptyString;
- }
- export type AssociatedStandardsList = AssociatedStandard[];
- export interface AssociationFilters {
- /**
- * The ARN or UUID of the configuration policy.
- */
- ConfigurationPolicyId?: NonEmptyString;
- /**
- * Indicates whether the association between a target and a configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.
- */
- AssociationType?: AssociationType;
- /**
- * The current status of the association between a target and a configuration policy.
- */
- AssociationStatus?: ConfigurationPolicyAssociationStatus;
- }
- export interface AssociationSetDetails {
- /**
- * The state of the association between a route table and a subnet or gateway.
- */
- AssociationState?: AssociationStateDetails;
- /**
- * The ID of the internet gateway or virtual private gateway.
- */
- GatewayId?: NonEmptyString;
- /**
- * Indicates whether this is the main route table.
- */
- Main?: Boolean;
- /**
- * The ID of the association.
- */
- RouteTableAssociationId?: NonEmptyString;
- /**
- * The ID of the route table.
- */
- RouteTableId?: NonEmptyString;
- /**
- * The ID of the subnet. A subnet ID is not returned for an implicit association.
- */
- SubnetId?: NonEmptyString;
- }
- export type AssociationSetList = AssociationSetDetails[];
- export interface AssociationStateDetails {
- /**
- * The state of the association.
- */
- State?: NonEmptyString;
- /**
- * The status message, if applicable.
- */
- StatusMessage?: NonEmptyString;
- }
- export type AssociationStatus = "ENABLED"|"DISABLED"|string;
- export type AssociationType = "INHERITED"|"APPLIED"|string;
- export type AutoEnableStandards = "NONE"|"DEFAULT"|string;
- export interface AutomationRulesAction {
- /**
- * Specifies that the rule action should update the Types finding field. The Types finding field classifies findings in the format of namespace/category/classifier. For more information, see Types taxonomy for ASFF in the Security Hub User Guide.
- */
- Type?: AutomationRulesActionType;
- /**
- * Specifies that the automation rule action is an update to a finding field.
- */
- FindingFieldsUpdate?: AutomationRulesFindingFieldsUpdate;
- }
- export type AutomationRulesActionType = "FINDING_FIELDS_UPDATE"|string;
- export type AutomationRulesArnsList = NonEmptyString[];
- export interface AutomationRulesConfig {
- /**
- * The Amazon Resource Name (ARN) of a rule.
- */
- RuleArn?: NonEmptyString;
- /**
- * Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created.
- */
- RuleStatus?: RuleStatus;
- /**
- * An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
- */
- RuleOrder?: RuleOrderValue;
- /**
- * The name of the rule.
- */
- RuleName?: NonEmptyString;
- /**
- * A description of the rule.
- */
- Description?: NonEmptyString;
- /**
- * Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
- */
- IsTerminal?: Boolean;
- /**
- * A set of Amazon Web Services Security Finding Format finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
- */
- Criteria?: AutomationRulesFindingFilters;
- /**
- * One or more actions to update finding fields if a finding matches the defined criteria of the rule.
- */
- Actions?: ActionList;
- /**
- * A timestamp that indicates when the rule was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: Timestamp;
- /**
- * A timestamp that indicates when the rule was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt?: Timestamp;
- /**
- * The principal that created a rule.
- */
- CreatedBy?: NonEmptyString;
- }
- export type AutomationRulesConfigList = AutomationRulesConfig[];
- export interface AutomationRulesFindingFieldsUpdate {
- Note?: NoteUpdate;
- Severity?: SeverityUpdate;
- /**
- * The rule action updates the VerificationState field of a finding.
- */
- VerificationState?: VerificationState;
- /**
- * The rule action updates the Confidence field of a finding.
- */
- Confidence?: RatioScale;
- /**
- * The rule action updates the Criticality field of a finding.
- */
- Criticality?: RatioScale;
- /**
- * The rule action updates the Types field of a finding.
- */
- Types?: TypeList;
- /**
- * The rule action updates the UserDefinedFields field of a finding.
- */
- UserDefinedFields?: FieldMap;
- Workflow?: WorkflowUpdate;
- /**
- * The rule action updates the RelatedFindings field of a finding.
- */
- RelatedFindings?: RelatedFindingList;
- }
- export interface AutomationRulesFindingFilters {
- /**
- * The Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ProductArn?: StringFilterList;
- /**
- * The Amazon Web Services account ID in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 100 items.
- */
- AwsAccountId?: StringFilterList;
- /**
- * The product-specific identifier for a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- Id?: StringFilterList;
- /**
- * The identifier for the solution-specific component that generated a finding. Array Members: Minimum number of 1 item. Maximum number of 100 items.
- */
- GeneratorId?: StringFilterList;
- /**
- * One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- Type?: StringFilterList;
- /**
- * A timestamp that indicates when the potential security issue captured by a finding was first observed by the security findings product. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59) Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- FirstObservedAt?: DateFilterList;
- /**
- * A timestamp that indicates when the potential security issue captured by a finding was most recently observed by the security findings product. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59) Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- LastObservedAt?: DateFilterList;
- /**
- * A timestamp that indicates when this finding record was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59) Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- CreatedAt?: DateFilterList;
- /**
- * A timestamp that indicates when the finding record was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59) Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- UpdatedAt?: DateFilterList;
- /**
- * The likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0–100 basis using a ratio scale. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- Confidence?: NumberFilterList;
- /**
- * The level of importance that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- Criticality?: NumberFilterList;
- /**
- * A finding's title. Array Members: Minimum number of 1 item. Maximum number of 100 items.
- */
- Title?: StringFilterList;
- /**
- * A finding's description. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- Description?: StringFilterList;
- /**
- * Provides a URL that links to a page about the current finding in the finding product. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- SourceUrl?: StringFilterList;
- /**
- * Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ProductName?: StringFilterList;
- /**
- * The name of the company for the product that generated the finding. For control-based findings, the company is Amazon Web Services. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- CompanyName?: StringFilterList;
- /**
- * The severity value of the finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- SeverityLabel?: StringFilterList;
- /**
- * The type of resource that the finding pertains to. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceType?: StringFilterList;
- /**
- * The identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource. Array Members: Minimum number of 1 item. Maximum number of 100 items.
- */
- ResourceId?: StringFilterList;
- /**
- * The partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourcePartition?: StringFilterList;
- /**
- * The Amazon Web Services Region where the resource that a finding pertains to is located. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceRegion?: StringFilterList;
- /**
- * A list of Amazon Web Services tags associated with a resource at the time the finding was processed. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceTags?: MapFilterList;
- /**
- * Custom fields and values about the resource that a finding pertains to. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceDetailsOther?: MapFilterList;
- /**
- * The result of a security check. This field is only used for findings generated from controls. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ComplianceStatus?: StringFilterList;
- /**
- * The security control ID for which a finding was generated. Security control IDs are the same across standards. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ComplianceSecurityControlId?: StringFilterList;
- /**
- * The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ComplianceAssociatedStandardsId?: StringFilterList;
- /**
- * Provides the veracity of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- VerificationState?: StringFilterList;
- /**
- * Provides information about the status of the investigation into a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- WorkflowStatus?: StringFilterList;
- /**
- * Provides the current state of a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- RecordState?: StringFilterList;
- /**
- * The ARN for the product that generated a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- RelatedFindingsProductArn?: StringFilterList;
- /**
- * The product-generated identifier for a related finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- RelatedFindingsId?: StringFilterList;
- /**
- * The text of a user-defined note that's added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- NoteText?: StringFilterList;
- /**
- * The timestamp of when the note was updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59) Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- NoteUpdatedAt?: DateFilterList;
- /**
- * The principal that created a note. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- NoteUpdatedBy?: StringFilterList;
- /**
- * A list of user-defined name and value string pairs added to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- UserDefinedFields?: MapFilterList;
- /**
- * The Amazon Resource Name (ARN) of the application that is related to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceApplicationArn?: StringFilterList;
- /**
- * The name of the application that is related to a finding. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- ResourceApplicationName?: StringFilterList;
- /**
- * The name of the Amazon Web Services account in which a finding was generated. Array Members: Minimum number of 1 item. Maximum number of 20 items.
- */
- AwsAccountName?: StringFilterList;
- }
- export interface AutomationRulesMetadata {
- /**
- * The Amazon Resource Name (ARN) for the rule.
- */
- RuleArn?: NonEmptyString;
- /**
- * Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
- */
- RuleStatus?: RuleStatus;
- /**
- * An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
- */
- RuleOrder?: RuleOrderValue;
- /**
- * The name of the rule.
- */
- RuleName?: NonEmptyString;
- /**
- * A description of the rule.
- */
- Description?: NonEmptyString;
- /**
- * Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
- */
- IsTerminal?: Boolean;
- /**
- * A timestamp that indicates when the rule was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: Timestamp;
- /**
- * A timestamp that indicates when the rule was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt?: Timestamp;
- /**
- * The principal that created a rule.
- */
- CreatedBy?: NonEmptyString;
- }
- export type AutomationRulesMetadataList = AutomationRulesMetadata[];
- export interface AvailabilityZone {
- /**
- * The name of the Availability Zone.
- */
- ZoneName?: NonEmptyString;
- /**
- * The ID of the subnet. You can specify one subnet per Availability Zone.
- */
- SubnetId?: NonEmptyString;
- }
- export type AvailabilityZones = AvailabilityZone[];
- export interface AwsAmazonMqBrokerDetails {
- /**
- * The authentication strategy used to secure the broker. The default is SIMPLE.
- */
- AuthenticationStrategy?: NonEmptyString;
- /**
- * Whether automatically upgrade new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
- */
- AutoMinorVersionUpgrade?: Boolean;
- /**
- * The Amazon Resource Name (ARN) of the broker.
- */
- BrokerArn?: NonEmptyString;
- /**
- * The broker's name.
- */
- BrokerName?: NonEmptyString;
- /**
- * The broker's deployment mode.
- */
- DeploymentMode?: NonEmptyString;
- /**
- * Encryption options for the broker. Doesn’t apply to RabbitMQ brokers.
- */
- EncryptionOptions?: AwsAmazonMqBrokerEncryptionOptionsDetails;
- /**
- * The type of broker engine.
- */
- EngineType?: NonEmptyString;
- /**
- * The version of the broker engine.
- */
- EngineVersion?: NonEmptyString;
- /**
- * The broker's instance type.
- */
- HostInstanceType?: NonEmptyString;
- /**
- * The unique ID that Amazon MQ generates for the broker.
- */
- BrokerId?: NonEmptyString;
- /**
- * The metadata of the Lightweight Directory Access Protocol (LDAP) server used to authenticate and authorize connections to the broker. This is an optional failover server.
- */
- LdapServerMetadata?: AwsAmazonMqBrokerLdapServerMetadataDetails;
- /**
- * Turns on Amazon CloudWatch logging for brokers.
- */
- Logs?: AwsAmazonMqBrokerLogsDetails;
- /**
- * The scheduled time period (UTC) during which Amazon MQ begins to apply pending updates or patches to the broker.
- */
- MaintenanceWindowStartTime?: AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails;
- /**
- * Permits connections from applications outside of the VPC that hosts the broker's subnets.
- */
- PubliclyAccessible?: Boolean;
- /**
- * The list of rules (one minimum, 125 maximum) that authorize connections to brokers.
- */
- SecurityGroups?: StringList;
- /**
- * The broker's storage type.
- */
- StorageType?: NonEmptyString;
- /**
- * The list of groups that define which subnets and IP ranges the broker can use from different Availability Zones.
- */
- SubnetIds?: StringList;
- /**
- * The list of all broker usernames for the specified broker. Doesn't apply to RabbitMQ brokers.
- */
- Users?: AwsAmazonMqBrokerUsersList;
- }
- export interface AwsAmazonMqBrokerEncryptionOptionsDetails {
- /**
- * The KMS key that’s used to encrypt your data at rest. If not provided, Amazon MQ will use a default KMS key to encrypt your data.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * Specifies that an KMS key should be used for at-rest encryption. Set to true by default if no value is provided (for example, for RabbitMQ brokers).
- */
- UseAwsOwnedKey?: Boolean;
- }
- export interface AwsAmazonMqBrokerLdapServerMetadataDetails {
- /**
- * Specifies the location of the LDAP server, such as Amazon Web Services Directory Service for Microsoft Active Directory.
- */
- Hosts?: StringList;
- /**
- * The distinguished name of the node in the directory information tree (DIT) to search for roles or groups.
- */
- RoleBase?: NonEmptyString;
- /**
- * The group name attribute in a role entry whose value is the name of that role.
- */
- RoleName?: NonEmptyString;
- /**
- * The LDAP search filter used to find roles within the roleBase.
- */
- RoleSearchMatching?: NonEmptyString;
- /**
- * The directory search scope for the role. If set to true, the scope is to search the entire subtree.
- */
- RoleSearchSubtree?: Boolean;
- /**
- * A username for the service account, which is an account in your LDAP server that has access to initiate a connection.
- */
- ServiceAccountUsername?: NonEmptyString;
- /**
- * Selects a particular subtree of the directory information tree (DIT) to search for user entries.
- */
- UserBase?: NonEmptyString;
- /**
- * The name of the LDAP attribute in the user's directory entry for the user's group membership.
- */
- UserRoleName?: NonEmptyString;
- /**
- * The LDAP search filter used to find users within the userBase.
- */
- UserSearchMatching?: NonEmptyString;
- /**
- * The directory search scope for the user. If set to true, the scope is to search the entire subtree.
- */
- UserSearchSubtree?: Boolean;
- }
- export interface AwsAmazonMqBrokerLogsDetails {
- /**
- * Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
- */
- Audit?: Boolean;
- /**
- * Activates general logging.
- */
- General?: Boolean;
- /**
- * The location of the CloudWatch Logs log group where audit logs are sent.
- */
- AuditLogGroup?: NonEmptyString;
- /**
- * The location of the CloudWatch Logs log group where general logs are sent.
- */
- GeneralLogGroup?: NonEmptyString;
- /**
- * The list of information about logs that are to be turned on for the specified broker.
- */
- Pending?: AwsAmazonMqBrokerLogsPendingDetails;
- }
- export interface AwsAmazonMqBrokerLogsPendingDetails {
- /**
- * Activates audit logging. Every user management action made using JMX or the ActiveMQ Web Console is logged. Doesn't apply to RabbitMQ brokers.
- */
- Audit?: Boolean;
- /**
- * Activates general logging.
- */
- General?: Boolean;
- }
- export interface AwsAmazonMqBrokerMaintenanceWindowStartTimeDetails {
- /**
- * The day of the week on which the maintenance window falls.
- */
- DayOfWeek?: NonEmptyString;
- /**
- * The time, in 24-hour format, on which the maintenance window falls.
- */
- TimeOfDay?: NonEmptyString;
- /**
- * The time zone in either the Country/City format or the UTC offset format. UTC is the default format.
- */
- TimeZone?: NonEmptyString;
- }
- export interface AwsAmazonMqBrokerUsersDetails {
- /**
- * The type of change pending for the broker user.
- */
- PendingChange?: NonEmptyString;
- /**
- * The username of the broker user.
- */
- Username?: NonEmptyString;
- }
- export type AwsAmazonMqBrokerUsersList = AwsAmazonMqBrokerUsersDetails[];
- export interface AwsApiCallAction {
- /**
- * The name of the API method that was issued.
- */
- Api?: NonEmptyString;
- /**
- * The name of the Amazon Web Services service that the API method belongs to.
- */
- ServiceName?: NonEmptyString;
- /**
- * Indicates whether the API call originated from a remote IP address (remoteip) or from a DNS domain (domain).
- */
- CallerType?: NonEmptyString;
- /**
- * Provided if CallerType is remoteIp. Provides information about the remote IP address that the API call originated from.
- */
- RemoteIpDetails?: ActionRemoteIpDetails;
- /**
- * Provided if CallerType is domain. Provides information about the DNS domain that the API call originated from.
- */
- DomainDetails?: AwsApiCallActionDomainDetails;
- /**
- * Identifies the resources that were affected by the API call.
- */
- AffectedResources?: FieldMap;
- /**
- * A timestamp that indicates when the API call was first observed. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- FirstSeen?: NonEmptyString;
- /**
- * A timestamp that indicates when the API call was most recently observed. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastSeen?: NonEmptyString;
- }
- export interface AwsApiCallActionDomainDetails {
- /**
- * The name of the DNS domain that issued the API call.
- */
- Domain?: NonEmptyString;
- }
- export interface AwsApiGatewayAccessLogSettings {
- /**
- * A single-line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
- */
- Format?: NonEmptyString;
- /**
- * The ARN of the CloudWatch Logs log group that receives the access logs.
- */
- DestinationArn?: NonEmptyString;
- }
- export interface AwsApiGatewayCanarySettings {
- /**
- * The percentage of traffic that is diverted to a canary deployment.
- */
- PercentTraffic?: Double;
- /**
- * The deployment identifier for the canary deployment.
- */
- DeploymentId?: NonEmptyString;
- /**
- * Stage variables that are overridden in the canary release deployment. The variables include new stage variables that are introduced in the canary. Each variable is represented as a string-to-string map between the stage variable name and the variable value.
- */
- StageVariableOverrides?: FieldMap;
- /**
- * Indicates whether the canary deployment uses the stage cache.
- */
- UseStageCache?: Boolean;
- }
- export interface AwsApiGatewayEndpointConfiguration {
- /**
- * A list of endpoint types for the REST API. For an edge-optimized API, the endpoint type is EDGE. For a Regional API, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.
- */
- Types?: NonEmptyStringList;
- }
- export interface AwsApiGatewayMethodSettings {
- /**
- * Indicates whether CloudWatch metrics are enabled for the method.
- */
- MetricsEnabled?: Boolean;
- /**
- * The logging level for this method. The logging level affects the log entries that are pushed to CloudWatch Logs. If the logging level is ERROR, then the logs only include error-level entries. If the logging level is INFO, then the logs include both ERROR events and extra informational events. Valid values: OFF | ERROR | INFO
- */
- LoggingLevel?: NonEmptyString;
- /**
- * Indicates whether data trace logging is enabled for the method. Data trace logging affects the log entries that are pushed to CloudWatch Logs.
- */
- DataTraceEnabled?: Boolean;
- /**
- * The throttling burst limit for the method.
- */
- ThrottlingBurstLimit?: Integer;
- /**
- * The throttling rate limit for the method.
- */
- ThrottlingRateLimit?: Double;
- /**
- * Indicates whether responses are cached and returned for requests. For responses to be cached, a cache cluster must be enabled on the stage.
- */
- CachingEnabled?: Boolean;
- /**
- * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response is cached.
- */
- CacheTtlInSeconds?: Integer;
- /**
- * Indicates whether the cached responses are encrypted.
- */
- CacheDataEncrypted?: Boolean;
- /**
- * Indicates whether authorization is required for a cache invalidation request.
- */
- RequireAuthorizationForCacheControl?: Boolean;
- /**
- * Indicates how to handle unauthorized requests for cache invalidation. Valid values: FAIL_WITH_403 | SUCCEED_WITH_RESPONSE_HEADER | SUCCEED_WITHOUT_RESPONSE_HEADER
- */
- UnauthorizedCacheControlHeaderStrategy?: NonEmptyString;
- /**
- * The HTTP method. You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- */
- HttpMethod?: NonEmptyString;
- /**
- * The resource path for this method. Forward slashes (/) are encoded as ~1 . The initial slash must include a forward slash. For example, the path value /resource/subresource must be encoded as /~1resource~1subresource. To specify the root path, use only a slash (/). You can use an asterisk (*) as a wildcard to apply method settings to multiple methods.
- */
- ResourcePath?: NonEmptyString;
- }
- export type AwsApiGatewayMethodSettingsList = AwsApiGatewayMethodSettings[];
- export interface AwsApiGatewayRestApiDetails {
- /**
- * The identifier of the REST API.
- */
- Id?: NonEmptyString;
- /**
- * The name of the REST API.
- */
- Name?: NonEmptyString;
- /**
- * A description of the REST API.
- */
- Description?: NonEmptyString;
- /**
- * Indicates when the API was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedDate?: NonEmptyString;
- /**
- * The version identifier for the REST API.
- */
- Version?: NonEmptyString;
- /**
- * The list of binary media types supported by the REST API.
- */
- BinaryMediaTypes?: NonEmptyStringList;
- /**
- * The minimum size in bytes of a payload before compression is enabled. If null, then compression is disabled. If 0, then all payloads are compressed.
- */
- MinimumCompressionSize?: Integer;
- /**
- * The source of the API key for metering requests according to a usage plan. HEADER indicates whether to read the API key from the X-API-Key header of a request. AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.
- */
- ApiKeySource?: NonEmptyString;
- /**
- * The endpoint configuration of the REST API.
- */
- EndpointConfiguration?: AwsApiGatewayEndpointConfiguration;
- }
- export interface AwsApiGatewayStageDetails {
- /**
- * The identifier of the deployment that the stage points to.
- */
- DeploymentId?: NonEmptyString;
- /**
- * The identifier of the client certificate for the stage.
- */
- ClientCertificateId?: NonEmptyString;
- /**
- * The name of the stage.
- */
- StageName?: NonEmptyString;
- /**
- * A description of the stage.
- */
- Description?: NonEmptyString;
- /**
- * Indicates whether a cache cluster is enabled for the stage.
- */
- CacheClusterEnabled?: Boolean;
- /**
- * If a cache cluster is enabled, the size of the cache cluster.
- */
- CacheClusterSize?: NonEmptyString;
- /**
- * If a cache cluster is enabled, the status of the cache cluster.
- */
- CacheClusterStatus?: NonEmptyString;
- /**
- * Defines the method settings for the stage.
- */
- MethodSettings?: AwsApiGatewayMethodSettingsList;
- /**
- * A map that defines the stage variables for the stage. Variable names can have alphanumeric and underscore characters. Variable values can contain the following characters: Uppercase and lowercase letters Numbers Special characters -._~:/?#&=,
- */
- Variables?: FieldMap;
- /**
- * The version of the API documentation that is associated with the stage.
- */
- DocumentationVersion?: NonEmptyString;
- /**
- * Settings for logging access for the stage.
- */
- AccessLogSettings?: AwsApiGatewayAccessLogSettings;
- /**
- * Information about settings for canary deployment in the stage.
- */
- CanarySettings?: AwsApiGatewayCanarySettings;
- /**
- * Indicates whether active tracing with X-Ray is enabled for the stage.
- */
- TracingEnabled?: Boolean;
- /**
- * Indicates when the stage was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedDate?: NonEmptyString;
- /**
- * Indicates when the stage was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastUpdatedDate?: NonEmptyString;
- /**
- * The ARN of the web ACL associated with the stage.
- */
- WebAclArn?: NonEmptyString;
- }
- export interface AwsApiGatewayV2ApiDetails {
- /**
- * The URI of the API. Uses the format <api-id>.execute-api.<region>.amazonaws.com The stage name is typically appended to the URI to form a complete path to a deployed API stage.
- */
- ApiEndpoint?: NonEmptyString;
- /**
- * The identifier of the API.
- */
- ApiId?: NonEmptyString;
- /**
- * An API key selection expression. Supported only for WebSocket APIs.
- */
- ApiKeySelectionExpression?: NonEmptyString;
- /**
- * Indicates when the API was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedDate?: NonEmptyString;
- /**
- * A description of the API.
- */
- Description?: NonEmptyString;
- /**
- * The version identifier for the API.
- */
- Version?: NonEmptyString;
- /**
- * The name of the API.
- */
- Name?: NonEmptyString;
- /**
- * The API protocol for the API. Valid values: WEBSOCKET | HTTP
- */
- ProtocolType?: NonEmptyString;
- /**
- * The route selection expression for the API. For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs. For WebSocket APIs, there is no default value.
- */
- RouteSelectionExpression?: NonEmptyString;
- /**
- * A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
- */
- CorsConfiguration?: AwsCorsConfiguration;
- }
- export interface AwsApiGatewayV2RouteSettings {
- /**
- * Indicates whether detailed metrics are enabled.
- */
- DetailedMetricsEnabled?: Boolean;
- /**
- * The logging level. The logging level affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs. If the logging level is ERROR, then the logs only include error-level entries. If the logging level is INFO, then the logs include both ERROR events and extra informational events. Valid values: OFF | ERROR | INFO
- */
- LoggingLevel?: NonEmptyString;
- /**
- * Indicates whether data trace logging is enabled. Data trace logging affects the log entries that are pushed to CloudWatch Logs. Supported only for WebSocket APIs.
- */
- DataTraceEnabled?: Boolean;
- /**
- * The throttling burst limit.
- */
- ThrottlingBurstLimit?: Integer;
- /**
- * The throttling rate limit.
- */
- ThrottlingRateLimit?: Double;
- }
- export interface AwsApiGatewayV2StageDetails {
- /**
- * The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
- */
- ClientCertificateId?: NonEmptyString;
- /**
- * Indicates when the stage was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedDate?: NonEmptyString;
- /**
- * The description of the stage.
- */
- Description?: NonEmptyString;
- /**
- * Default route settings for the stage.
- */
- DefaultRouteSettings?: AwsApiGatewayV2RouteSettings;
- /**
- * The identifier of the deployment that the stage is associated with.
- */
- DeploymentId?: NonEmptyString;
- /**
- * Indicates when the stage was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastUpdatedDate?: NonEmptyString;
- /**
- * The route settings for the stage.
- */
- RouteSettings?: AwsApiGatewayV2RouteSettings;
- /**
- * The name of the stage.
- */
- StageName?: NonEmptyString;
- /**
- * A map that defines the stage variables for the stage. Variable names can have alphanumeric and underscore characters. Variable values can contain the following characters: Uppercase and lowercase letters Numbers Special characters -._~:/?#&=,
- */
- StageVariables?: FieldMap;
- /**
- * Information about settings for logging access for the stage.
- */
- AccessLogSettings?: AwsApiGatewayAccessLogSettings;
- /**
- * Indicates whether updates to an API automatically trigger a new deployment.
- */
- AutoDeploy?: Boolean;
- /**
- * The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
- */
- LastDeploymentStatusMessage?: NonEmptyString;
- /**
- * Indicates whether the stage is managed by API Gateway.
- */
- ApiGatewayManaged?: Boolean;
- }
- export interface AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails {
- /**
- * The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- */
- AuthenticationType?: NonEmptyString;
- /**
- * The configuration for Lambda function authorization.
- */
- LambdaAuthorizerConfig?: AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails;
- /**
- * The OpenID Connect configuration.
- */
- OpenIdConnectConfig?: AwsAppSyncGraphQlApiOpenIdConnectConfigDetails;
- /**
- * The Amazon Cognito user pools configuration.
- */
- UserPoolConfig?: AwsAppSyncGraphQlApiUserPoolConfigDetails;
- }
- export type AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList = AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersDetails[];
- export interface AwsAppSyncGraphQlApiDetails {
- /**
- * The unique identifier for the API.
- */
- ApiId?: NonEmptyString;
- /**
- * The unique identifier for the API.
- */
- Id?: NonEmptyString;
- /**
- * Specifies the authorization configuration for using an OpenID Connect compliant service with an AppSync GraphQL API endpoint.
- */
- OpenIdConnectConfig?: AwsAppSyncGraphQlApiOpenIdConnectConfigDetails;
- /**
- * The API name.
- */
- Name?: NonEmptyString;
- /**
- * Specifies the configuration for Lambda function authorization.
- */
- LambdaAuthorizerConfig?: AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails;
- /**
- * Indicates whether to use X-Ray tracing for the GraphQL API.
- */
- XrayEnabled?: Boolean;
- /**
- * The Amazon Resource Name (ARN) of the API.
- */
- Arn?: NonEmptyString;
- /**
- * The Amazon Cognito user pools configuration.
- */
- UserPoolConfig?: AwsAppSyncGraphQlApiUserPoolConfigDetails;
- /**
- * The type of security configuration for your GraphQL API: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.
- */
- AuthenticationType?: NonEmptyString;
- /**
- * The Amazon CloudWatch Logs configuration.
- */
- LogConfig?: AwsAppSyncGraphQlApiLogConfigDetails;
- /**
- * A list of additional authentication providers for the GraphQL API.
- */
- AdditionalAuthenticationProviders?: AwsAppSyncGraphQlApiAdditionalAuthenticationProvidersList;
- /**
- * The Amazon Resource Name (ARN) of the WAF web access control list (web ACL) associated with this GraphQL API, if one exists.
- */
- WafWebAclArn?: NonEmptyString;
- }
- export interface AwsAppSyncGraphQlApiLambdaAuthorizerConfigDetails {
- /**
- * The number of seconds a response should be cached for. The default is 5 minutes (300 seconds).
- */
- AuthorizerResultTtlInSeconds?: Integer;
- /**
- * The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.
- */
- AuthorizerUri?: NonEmptyString;
- /**
- * A regular expression for validation of tokens before the Lambda function is called.
- */
- IdentityValidationExpression?: NonEmptyString;
- }
- export interface AwsAppSyncGraphQlApiLogConfigDetails {
- /**
- * The Amazon Resource Name (ARN) of the service role that AppSync assumes to publish to CloudWatch Logs in your account.
- */
- CloudWatchLogsRoleArn?: NonEmptyString;
- /**
- * Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
- */
- ExcludeVerboseContent?: Boolean;
- /**
- * The field logging level.
- */
- FieldLogLevel?: NonEmptyString;
- }
- export interface AwsAppSyncGraphQlApiOpenIdConnectConfigDetails {
- /**
- * The number of milliseconds that a token is valid after being authenticated.
- */
- AuthTtL?: Long;
- /**
- * The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.
- */
- ClientId?: NonEmptyString;
- /**
- * The number of milliseconds that a token is valid after it's issued to a user.
- */
- IatTtL?: Long;
- /**
- * The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
- */
- Issuer?: NonEmptyString;
- }
- export interface AwsAppSyncGraphQlApiUserPoolConfigDetails {
- /**
- * A regular expression for validating the incoming Amazon Cognito user pools app client ID. If this value isn't set, no filtering is applied.
- */
- AppIdClientRegex?: NonEmptyString;
- /**
- * The Amazon Web Services Region in which the user pool was created.
- */
- AwsRegion?: NonEmptyString;
- /**
- * The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pools authentication doesn't match the Amazon Cognito user pools configuration.
- */
- DefaultAction?: NonEmptyString;
- /**
- * The user pool ID.
- */
- UserPoolId?: NonEmptyString;
- }
- export interface AwsAthenaWorkGroupConfigurationDetails {
- /**
- * The location in Amazon S3 where query and calculation results are stored and the encryption option, if any, used for query and calculation results. These are known as client-side settings. If workgroup settings override client-side settings, then the query uses the workgroup settings.
- */
- ResultConfiguration?: AwsAthenaWorkGroupConfigurationResultConfigurationDetails;
- }
- export interface AwsAthenaWorkGroupConfigurationResultConfigurationDetails {
- /**
- * Specifies the method used to encrypt the user’s data stores in the Athena workgroup.
- */
- EncryptionConfiguration?: AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails;
- }
- export interface AwsAthenaWorkGroupConfigurationResultConfigurationEncryptionConfigurationDetails {
- /**
- * Indicates whether Amazon Simple Storage Service (Amazon S3) server-side encryption with Amazon S3 managed keys (SSE_S3), server-side encryption with KMS keys (SSE_KMS), or client-side encryption with KMS customer managed keys (CSE_KMS) is used.
- */
- EncryptionOption?: NonEmptyString;
- /**
- * For SSE_KMS and CSE_KMS, this is the KMS key Amazon Resource Name (ARN) or ID.
- */
- KmsKey?: NonEmptyString;
- }
- export interface AwsAthenaWorkGroupDetails {
- /**
- * The workgroup name.
- */
- Name?: NonEmptyString;
- /**
- * The workgroup description.
- */
- Description?: NonEmptyString;
- /**
- * Whether the workgroup is enabled or disabled.
- */
- State?: NonEmptyString;
- /**
- * The configuration of the workgroup, which includes the location in Amazon Simple Storage Service (Amazon S3) where query results are stored, the encryption option, if any, used for query results, whether Amazon CloudWatch metrics are enabled for the workgroup, and the limit for the amount of bytes scanned (cutoff) per query, if it is specified.
- */
- Configuration?: AwsAthenaWorkGroupConfigurationDetails;
- }
- export type AwsAutoScalingAutoScalingGroupAvailabilityZonesList = AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails[];
- export interface AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails {
- /**
- * The name of the Availability Zone.
- */
- Value?: NonEmptyString;
- }
- export interface AwsAutoScalingAutoScalingGroupDetails {
- /**
- * The name of the launch configuration.
- */
- LaunchConfigurationName?: NonEmptyString;
- /**
- * The list of load balancers associated with the group.
- */
- LoadBalancerNames?: StringList;
- /**
- * The service to use for the health checks. Valid values are EC2 or ELB.
- */
- HealthCheckType?: NonEmptyString;
- /**
- * The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.
- */
- HealthCheckGracePeriod?: Integer;
- /**
- * Indicates when the auto scaling group was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedTime?: NonEmptyString;
- /**
- * The mixed instances policy for the automatic scaling group.
- */
- MixedInstancesPolicy?: AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails;
- /**
- * The list of Availability Zones for the automatic scaling group.
- */
- AvailabilityZones?: AwsAutoScalingAutoScalingGroupAvailabilityZonesList;
- /**
- * The launch template to use.
- */
- LaunchTemplate?: AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification;
- /**
- * Indicates whether capacity rebalancing is enabled.
- */
- CapacityRebalance?: Boolean;
- }
- export interface AwsAutoScalingAutoScalingGroupLaunchTemplateLaunchTemplateSpecification {
- /**
- * The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
- */
- LaunchTemplateId?: NonEmptyString;
- /**
- * The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
- */
- LaunchTemplateName?: NonEmptyString;
- /**
- * Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.
- */
- Version?: NonEmptyString;
- }
- export interface AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails {
- /**
- * The instances distribution. The instances distribution specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity.
- */
- InstancesDistribution?: AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails;
- /**
- * The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.
- */
- LaunchTemplate?: AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails;
- }
- export interface AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails {
- /**
- * How to allocate instance types to fulfill On-Demand capacity. The valid value is prioritized.
- */
- OnDemandAllocationStrategy?: NonEmptyString;
- /**
- * The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
- */
- OnDemandBaseCapacity?: Integer;
- /**
- * The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.
- */
- OnDemandPercentageAboveBaseCapacity?: Integer;
- /**
- * How to allocate instances across Spot Instance pools. Valid values are as follows: lowest-price capacity-optimized capacity-optimized-prioritized
- */
- SpotAllocationStrategy?: NonEmptyString;
- /**
- * The number of Spot Instance pools across which to allocate your Spot Instances.
- */
- SpotInstancePools?: Integer;
- /**
- * The maximum price per unit hour that you are willing to pay for a Spot Instance.
- */
- SpotMaxPrice?: NonEmptyString;
- }
- export interface AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails {
- /**
- * The launch template to use for a mixed instances policy.
- */
- LaunchTemplateSpecification?: AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification;
- /**
- * Property values to use to override the values in the launch template.
- */
- Overrides?: AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList;
- }
- export interface AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification {
- /**
- * The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
- */
- LaunchTemplateId?: NonEmptyString;
- /**
- * The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
- */
- LaunchTemplateName?: NonEmptyString;
- /**
- * Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.
- */
- Version?: NonEmptyString;
- }
- export type AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList = AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails[];
- export interface AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails {
- /**
- * The instance type. For example, m3.xlarge.
- */
- InstanceType?: NonEmptyString;
- /**
- * The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.
- */
- WeightedCapacity?: NonEmptyString;
- }
- export interface AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails {
- /**
- * The device name that is exposed to the EC2 instance. For example, /dev/sdh or xvdh.
- */
- DeviceName?: NonEmptyString;
- /**
- * Parameters that are used to automatically set up Amazon EBS volumes when an instance is launched.
- */
- Ebs?: AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails;
- /**
- * Whether to suppress the device that is included in the block device mapping of the Amazon Machine Image (AMI). If NoDevice is true, then you cannot specify Ebs.>
- */
- NoDevice?: Boolean;
- /**
- * The name of the virtual device (for example, ephemeral0). You can provide either VirtualName or Ebs, but not both.
- */
- VirtualName?: NonEmptyString;
- }
- export interface AwsAutoScalingLaunchConfigurationBlockDeviceMappingsEbsDetails {
- /**
- * Whether to delete the volume when the instance is terminated.
- */
- DeleteOnTermination?: Boolean;
- /**
- * Whether to encrypt the volume.
- */
- Encrypted?: Boolean;
- /**
- * The number of input/output (I/O) operations per second (IOPS) to provision for the volume. Only supported for gp3 or io1 volumes. Required for io1 volumes. Not used with standard, gp2, st1, or sc1 volumes.
- */
- Iops?: Integer;
- /**
- * The snapshot ID of the volume to use. You must specify either VolumeSize or SnapshotId.
- */
- SnapshotId?: NonEmptyString;
- /**
- * The volume size, in GiBs. The following are the supported volumes sizes for each volume type: gp2 and gp3: 1-16,384 io1: 4-16,384 st1 and sc1: 125-16,384 standard: 1-1,024 You must specify either SnapshotId or VolumeSize. If you specify both SnapshotId and VolumeSize, the volume size must be equal or greater than the size of the snapshot.
- */
- VolumeSize?: Integer;
- /**
- * The volume type. Valid values are as follows: gp2 gp3 io1 sc1 st1 standard
- */
- VolumeType?: NonEmptyString;
- }
- export type AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList = AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails[];
- export interface AwsAutoScalingLaunchConfigurationDetails {
- /**
- * For Auto Scaling groups that run in a VPC, specifies whether to assign a public IP address to the group's instances.
- */
- AssociatePublicIpAddress?: Boolean;
- /**
- * Specifies the block devices for the instance.
- */
- BlockDeviceMappings?: AwsAutoScalingLaunchConfigurationBlockDeviceMappingsList;
- /**
- * The identifier of a ClassicLink-enabled VPC that EC2-Classic instances are linked to.
- */
- ClassicLinkVpcId?: NonEmptyString;
- /**
- * The identifiers of one or more security groups for the VPC that is specified in ClassicLinkVPCId.
- */
- ClassicLinkVpcSecurityGroups?: NonEmptyStringList;
- /**
- * The creation date and time for the launch configuration. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedTime?: NonEmptyString;
- /**
- * Whether the launch configuration is optimized for Amazon EBS I/O.
- */
- EbsOptimized?: Boolean;
- /**
- * The name or the ARN of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role.
- */
- IamInstanceProfile?: NonEmptyString;
- /**
- * The identifier of the Amazon Machine Image (AMI) that is used to launch EC2 instances.
- */
- ImageId?: NonEmptyString;
- /**
- * Indicates the type of monitoring for instances in the group.
- */
- InstanceMonitoring?: AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails;
- /**
- * The instance type for the instances.
- */
- InstanceType?: NonEmptyString;
- /**
- * The identifier of the kernel associated with the AMI.
- */
- KernelId?: NonEmptyString;
- /**
- * The name of the key pair.
- */
- KeyName?: NonEmptyString;
- /**
- * The name of the launch configuration.
- */
- LaunchConfigurationName?: NonEmptyString;
- /**
- * The tenancy of the instance. An instance with dedicated tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC.
- */
- PlacementTenancy?: NonEmptyString;
- /**
- * The identifier of the RAM disk associated with the AMI.
- */
- RamdiskId?: NonEmptyString;
- /**
- * The security groups to assign to the instances in the Auto Scaling group.
- */
- SecurityGroups?: NonEmptyStringList;
- /**
- * The maximum hourly price to be paid for any Spot Instance that is launched to fulfill the request.
- */
- SpotPrice?: NonEmptyString;
- /**
- * The user data to make available to the launched EC2 instances. Must be base64-encoded text.
- */
- UserData?: NonEmptyString;
- /**
- * The metadata options for the instances.
- */
- MetadataOptions?: AwsAutoScalingLaunchConfigurationMetadataOptions;
- }
- export interface AwsAutoScalingLaunchConfigurationInstanceMonitoringDetails {
- /**
- * If set to true, then instances in the group launch with detailed monitoring. If set to false, then instances in the group launch with basic monitoring.
- */
- Enabled?: Boolean;
- }
- export interface AwsAutoScalingLaunchConfigurationMetadataOptions {
- /**
- * Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.
- */
- HttpEndpoint?: NonEmptyString;
- /**
- * The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
- */
- HttpPutResponseHopLimit?: Integer;
- /**
- * Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.
- */
- HttpTokens?: NonEmptyString;
- }
- export interface AwsBackupBackupPlanAdvancedBackupSettingsDetails {
- /**
- * Specifies the backup option for a selected resource. This option is only available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid values are as follows: Set to WindowsVSS: enabled to enable the WindowsVSS backup option and create a Windows VSS backup. Set to WindowsVSS: disabled to create a regular backup. The WindowsVSS option is not enabled by default.
- */
- BackupOptions?: FieldMap;
- /**
- * The name of a resource type. The only supported resource type is Amazon EC2 instances with Windows VSS. The only valid value is EC2.
- */
- ResourceType?: NonEmptyString;
- }
- export type AwsBackupBackupPlanAdvancedBackupSettingsList = AwsBackupBackupPlanAdvancedBackupSettingsDetails[];
- export interface AwsBackupBackupPlanBackupPlanDetails {
- /**
- * The display name of a backup plan.
- */
- BackupPlanName?: NonEmptyString;
- /**
- * A list of backup options for each resource type.
- */
- AdvancedBackupSettings?: AwsBackupBackupPlanAdvancedBackupSettingsList;
- /**
- * An array of BackupRule objects, each of which specifies a scheduled task that is used to back up a selection of resources.
- */
- BackupPlanRule?: AwsBackupBackupPlanRuleList;
- }
- export interface AwsBackupBackupPlanDetails {
- /**
- * Uniquely identifies the backup plan to be associated with the selection of resources.
- */
- BackupPlan?: AwsBackupBackupPlanBackupPlanDetails;
- /**
- * An Amazon Resource Name (ARN) that uniquely identifies the backup plan.
- */
- BackupPlanArn?: NonEmptyString;
- /**
- * A unique ID for the backup plan.
- */
- BackupPlanId?: NonEmptyString;
- /**
- * Unique, randomly generated, Unicode, UTF-8 encoded strings. Version IDs cannot be edited.
- */
- VersionId?: NonEmptyString;
- }
- export interface AwsBackupBackupPlanLifecycleDetails {
- /**
- * Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
- */
- DeleteAfterDays?: Long;
- /**
- * Specifies the number of days after creation that a recovery point is moved to cold storage.
- */
- MoveToColdStorageAfterDays?: Long;
- }
- export interface AwsBackupBackupPlanRuleCopyActionsDetails {
- /**
- * An Amazon Resource Name (ARN) that uniquely identifies the destination backup vault for the copied backup.
- */
- DestinationBackupVaultArn?: NonEmptyString;
- /**
- * Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
- */
- Lifecycle?: AwsBackupBackupPlanLifecycleDetails;
- }
- export type AwsBackupBackupPlanRuleCopyActionsList = AwsBackupBackupPlanRuleCopyActionsDetails[];
- export interface AwsBackupBackupPlanRuleDetails {
- /**
- * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of letters, numbers, and hyphens.
- */
- TargetBackupVault?: NonEmptyString;
- /**
- * A value in minutes after a backup is scheduled before a job will be canceled if it doesn't start successfully.
- */
- StartWindowMinutes?: Long;
- /**
- * A cron expression in UTC specifying when Backup initiates a backup job.
- */
- ScheduleExpression?: NonEmptyString;
- /**
- * A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.' characters.
- */
- RuleName?: NonEmptyString;
- /**
- * Uniquely identifies a rule that is used to schedule the backup of a selection of resources.
- */
- RuleId?: NonEmptyString;
- /**
- * Specifies whether Backup creates continuous backups capable of point-in-time restore (PITR).
- */
- EnableContinuousBackup?: Boolean;
- /**
- * A value in minutes after a backup job is successfully started before it must be completed, or it is canceled by Backup.
- */
- CompletionWindowMinutes?: Long;
- /**
- * An array of CopyAction objects, each of which contains details of the copy operation.
- */
- CopyActions?: AwsBackupBackupPlanRuleCopyActionsList;
- /**
- * Defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. If you do not specify a lifecycle, Backup applies the lifecycle policy of the source backup to the destination backup. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days.
- */
- Lifecycle?: AwsBackupBackupPlanLifecycleDetails;
- }
- export type AwsBackupBackupPlanRuleList = AwsBackupBackupPlanRuleDetails[];
- export interface AwsBackupBackupVaultDetails {
- /**
- * An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
- */
- BackupVaultArn?: NonEmptyString;
- /**
- * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- */
- BackupVaultName?: NonEmptyString;
- /**
- * The unique ARN associated with the server-side encryption key. You can specify a key to encrypt your backups from services that support full Backup management. If you do not specify a key, Backup creates an KMS key for you by default.
- */
- EncryptionKeyArn?: NonEmptyString;
- /**
- * The Amazon SNS event notifications for the specified backup vault.
- */
- Notifications?: AwsBackupBackupVaultNotificationsDetails;
- /**
- * A resource-based policy that is used to manage access permissions on the target backup vault.
- */
- AccessPolicy?: NonEmptyString;
- }
- export interface AwsBackupBackupVaultNotificationsDetails {
- /**
- * An array of events that indicate the status of jobs to back up resources to the backup vault. The following events are supported: BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
- */
- BackupVaultEvents?: NonEmptyStringList;
- /**
- * The Amazon Resource Name (ARN) that uniquely identifies the Amazon SNS topic for a backup vault's events.
- */
- SnsTopicArn?: NonEmptyString;
- }
- export interface AwsBackupRecoveryPointCalculatedLifecycleDetails {
- /**
- * Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
- */
- DeleteAt?: NonEmptyString;
- /**
- * Specifies the number of days after creation that a recovery point is moved to cold storage.
- */
- MoveToColdStorageAt?: NonEmptyString;
- }
- export interface AwsBackupRecoveryPointCreatedByDetails {
- /**
- * An Amazon Resource Name (ARN) that uniquely identifies a backup plan.
- */
- BackupPlanArn?: NonEmptyString;
- /**
- * Uniquely identifies a backup plan.
- */
- BackupPlanId?: NonEmptyString;
- /**
- * Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot be edited.
- */
- BackupPlanVersion?: NonEmptyString;
- /**
- * Uniquely identifies a rule used to schedule the backup of a selection of resources.
- */
- BackupRuleId?: NonEmptyString;
- }
- export interface AwsBackupRecoveryPointDetails {
- /**
- * The size, in bytes, of a backup.
- */
- BackupSizeInBytes?: Long;
- /**
- * An Amazon Resource Name (ARN) that uniquely identifies a backup vault.
- */
- BackupVaultArn?: NonEmptyString;
- /**
- * The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the Amazon Web Services account used to create them and the Amazon Web Services Region where they are created. They consist of lowercase letters, numbers, and hyphens.
- */
- BackupVaultName?: NonEmptyString;
- /**
- * A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt timestamps.
- */
- CalculatedLifecycle?: AwsBackupRecoveryPointCalculatedLifecycleDetails;
- /**
- * The date and time that a job to create a recovery point is completed, in Unix format and UTC. The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- */
- CompletionDate?: NonEmptyString;
- /**
- * Contains identifying information about the creation of a recovery point, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.
- */
- CreatedBy?: AwsBackupRecoveryPointCreatedByDetails;
- /**
- * The date and time a recovery point is created, in Unix format and UTC. The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- */
- CreationDate?: NonEmptyString;
- /**
- * The ARN for the server-side encryption key that is used to protect your backups.
- */
- EncryptionKeyArn?: NonEmptyString;
- /**
- * Specifies the IAM role ARN used to create the target recovery point
- */
- IamRoleArn?: NonEmptyString;
- /**
- * A Boolean value that is returned as TRUE if the specified recovery point is encrypted, or FALSE if the recovery point is not encrypted.
- */
- IsEncrypted?: Boolean;
- /**
- * The date and time that a recovery point was last restored, in Unix format and UTC. The value of LastRestoreTime is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
- */
- LastRestoreTime?: NonEmptyString;
- /**
- * The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define
- */
- Lifecycle?: AwsBackupRecoveryPointLifecycleDetails;
- /**
- * An ARN that uniquely identifies a recovery point.
- */
- RecoveryPointArn?: NonEmptyString;
- /**
- * An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
- */
- ResourceArn?: NonEmptyString;
- /**
- * The type of Amazon Web Services resource saved as a recovery point, such as an Amazon EBS volume or an Amazon RDS database.
- */
- ResourceType?: NonEmptyString;
- /**
- * The ARN for the backup vault where the recovery point was originally copied from. If the recovery point is restored to the same account, this value will be null.
- */
- SourceBackupVaultArn?: NonEmptyString;
- /**
- * A status code specifying the state of the recovery point. Valid values are as follows: COMPLETED DELETING EXPIRED PARTIAL
- */
- Status?: NonEmptyString;
- /**
- * A message explaining the reason of the recovery point deletion failure.
- */
- StatusMessage?: NonEmptyString;
- /**
- * Specifies the storage class of the recovery point. Valid values are as follows: COLD DELETED WARM
- */
- StorageClass?: NonEmptyString;
- }
- export interface AwsBackupRecoveryPointLifecycleDetails {
- /**
- * Specifies the number of days after creation that a recovery point is deleted. Must be greater than 90 days plus MoveToColdStorageAfterDays.
- */
- DeleteAfterDays?: Long;
- /**
- * Specifies the number of days after creation that a recovery point is moved to cold storage.
- */
- MoveToColdStorageAfterDays?: Long;
- }
- export interface AwsCertificateManagerCertificateDetails {
- /**
- * The ARN of the private certificate authority (CA) that will be used to issue the certificate.
- */
- CertificateAuthorityArn?: NonEmptyString;
- /**
- * Indicates when the certificate was requested. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: NonEmptyString;
- /**
- * The fully qualified domain name (FQDN), such as www.example.com, that is secured by the certificate.
- */
- DomainName?: NonEmptyString;
- /**
- * Contains information about the initial validation of each domain name that occurs as a result of the RequestCertificate request. Only provided if the certificate type is AMAZON_ISSUED.
- */
- DomainValidationOptions?: AwsCertificateManagerCertificateDomainValidationOptions;
- /**
- * Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).
- */
- ExtendedKeyUsages?: AwsCertificateManagerCertificateExtendedKeyUsages;
- /**
- * For a failed certificate request, the reason for the failure. Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER
- */
- FailureReason?: NonEmptyString;
- /**
- * Indicates when the certificate was imported. Provided if the certificate type is IMPORTED. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ImportedAt?: NonEmptyString;
- /**
- * The list of ARNs for the Amazon Web Services resources that use the certificate.
- */
- InUseBy?: StringList;
- /**
- * Indicates when the certificate was issued. Provided if the certificate type is AMAZON_ISSUED. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- IssuedAt?: NonEmptyString;
- /**
- * The name of the certificate authority that issued and signed the certificate.
- */
- Issuer?: NonEmptyString;
- /**
- * The algorithm that was used to generate the public-private key pair. Valid values: RSA_2048 | RSA_1024 | RSA_4096 | EC_prime256v1 | EC_secp384r1 | EC_secp521r1
- */
- KeyAlgorithm?: NonEmptyString;
- /**
- * A list of key usage X.509 v3 extension objects.
- */
- KeyUsages?: AwsCertificateManagerCertificateKeyUsages;
- /**
- * The time after which the certificate becomes invalid. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- NotAfter?: NonEmptyString;
- /**
- * The time before which the certificate is not valid. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- NotBefore?: NonEmptyString;
- /**
- * Provides a value that specifies whether to add the certificate to a transparency log.
- */
- Options?: AwsCertificateManagerCertificateOptions;
- /**
- * Whether the certificate is eligible for renewal. Valid values: ELIGIBLE | INELIGIBLE
- */
- RenewalEligibility?: NonEmptyString;
- /**
- * Information about the status of the Certificate Manager managed renewal for the certificate. Provided only when the certificate type is AMAZON_ISSUED.
- */
- RenewalSummary?: AwsCertificateManagerCertificateRenewalSummary;
- /**
- * The serial number of the certificate.
- */
- Serial?: NonEmptyString;
- /**
- * The algorithm that was used to sign the certificate.
- */
- SignatureAlgorithm?: NonEmptyString;
- /**
- * The status of the certificate. Valid values: PENDING_VALIDATION | ISSUED | INACTIVE | EXPIRED | VALIDATION_TIMED_OUT | REVOKED | FAILED
- */
- Status?: NonEmptyString;
- /**
- * The name of the entity that is associated with the public key contained in the certificate.
- */
- Subject?: NonEmptyString;
- /**
- * One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.
- */
- SubjectAlternativeNames?: StringList;
- /**
- * The source of the certificate. For certificates that Certificate Manager provides, Type is AMAZON_ISSUED. For certificates that are imported with ImportCertificate, Type is IMPORTED. Valid values: IMPORTED | AMAZON_ISSUED | PRIVATE
- */
- Type?: NonEmptyString;
- }
- export interface AwsCertificateManagerCertificateDomainValidationOption {
- /**
- * A fully qualified domain name (FQDN) in the certificate.
- */
- DomainName?: NonEmptyString;
- /**
- * The CNAME record that is added to the DNS database for domain validation.
- */
- ResourceRecord?: AwsCertificateManagerCertificateResourceRecord;
- /**
- * The domain name that Certificate Manager uses to send domain validation emails.
- */
- ValidationDomain?: NonEmptyString;
- /**
- * A list of email addresses that Certificate Manager uses to send domain validation emails.
- */
- ValidationEmails?: StringList;
- /**
- * The method used to validate the domain name.
- */
- ValidationMethod?: NonEmptyString;
- /**
- * The validation status of the domain name.
- */
- ValidationStatus?: NonEmptyString;
- }
- export type AwsCertificateManagerCertificateDomainValidationOptions = AwsCertificateManagerCertificateDomainValidationOption[];
- export interface AwsCertificateManagerCertificateExtendedKeyUsage {
- /**
- * The name of an extension value. Indicates the purpose for which the certificate public key can be used.
- */
- Name?: NonEmptyString;
- /**
- * An object identifier (OID) for the extension value. The format is numbers separated by periods.
- */
- OId?: NonEmptyString;
- }
- export type AwsCertificateManagerCertificateExtendedKeyUsages = AwsCertificateManagerCertificateExtendedKeyUsage[];
- export interface AwsCertificateManagerCertificateKeyUsage {
- /**
- * The key usage extension name.
- */
- Name?: NonEmptyString;
- }
- export type AwsCertificateManagerCertificateKeyUsages = AwsCertificateManagerCertificateKeyUsage[];
- export interface AwsCertificateManagerCertificateOptions {
- /**
- * Whether to add the certificate to a transparency log. Valid values: DISABLED | ENABLED
- */
- CertificateTransparencyLoggingPreference?: NonEmptyString;
- }
- export interface AwsCertificateManagerCertificateRenewalSummary {
- /**
- * Information about the validation of each domain name in the certificate, as it pertains to Certificate Manager managed renewal. Provided only when the certificate type is AMAZON_ISSUED.
- */
- DomainValidationOptions?: AwsCertificateManagerCertificateDomainValidationOptions;
- /**
- * The status of the Certificate Manager managed renewal of the certificate. Valid values: PENDING_AUTO_RENEWAL | PENDING_VALIDATION | SUCCESS | FAILED
- */
- RenewalStatus?: NonEmptyString;
- /**
- * The reason that a renewal request was unsuccessful. This attribute is used only when RenewalStatus is FAILED. Valid values: NO_AVAILABLE_CONTACTS | ADDITIONAL_VERIFICATION_REQUIRED | DOMAIN_NOT_ALLOWED | INVALID_PUBLIC_DOMAIN | DOMAIN_VALIDATION_DENIED | CAA_ERROR | PCA_LIMIT_EXCEEDED | PCA_INVALID_ARN | PCA_INVALID_STATE | PCA_REQUEST_FAILED | PCA_NAME_CONSTRAINTS_VALIDATION | PCA_RESOURCE_NOT_FOUND | PCA_INVALID_ARGS | PCA_INVALID_DURATION | PCA_ACCESS_DENIED | SLR_NOT_FOUND | OTHER
- */
- RenewalStatusReason?: NonEmptyString;
- /**
- * Indicates when the renewal summary was last updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt?: NonEmptyString;
- }
- export interface AwsCertificateManagerCertificateResourceRecord {
- /**
- * The name of the resource.
- */
- Name?: NonEmptyString;
- /**
- * The type of resource.
- */
- Type?: NonEmptyString;
- /**
- * The value of the resource.
- */
- Value?: NonEmptyString;
- }
- export interface AwsCloudFormationStackDetails {
- /**
- * The capabilities allowed in the stack.
- */
- Capabilities?: NonEmptyStringList;
- /**
- * The time at which the stack was created.
- */
- CreationTime?: NonEmptyString;
- /**
- * A user-defined description associated with the stack.
- */
- Description?: NonEmptyString;
- /**
- * Boolean to enable or disable rollback on stack creation failures.
- */
- DisableRollback?: Boolean;
- /**
- * Information about whether a stack's actual configuration differs, or has drifted, from its expected configuration, as defined in the stack template and any values specified as template parameters.
- */
- DriftInformation?: AwsCloudFormationStackDriftInformationDetails;
- /**
- * Whether termination protection is enabled for the stack.
- */
- EnableTerminationProtection?: Boolean;
- /**
- * The time the nested stack was last updated. This field will only be returned if the stack has been updated at least once.
- */
- LastUpdatedTime?: NonEmptyString;
- /**
- * The Amazon Resource Names (ARNs) of the Amazon SNS topic to which stack-related events are published.
- */
- NotificationArns?: NonEmptyStringList;
- /**
- * A list of output structures.
- */
- Outputs?: AwsCloudFormationStackOutputsList;
- /**
- * The ARN of an IAM role that's associated with the stack.
- */
- RoleArn?: NonEmptyString;
- /**
- * Unique identifier of the stack.
- */
- StackId?: NonEmptyString;
- /**
- * The name associated with the stack.
- */
- StackName?: NonEmptyString;
- /**
- * Current status of the stack.
- */
- StackStatus?: NonEmptyString;
- /**
- * Success or failure message associated with the stack status.
- */
- StackStatusReason?: NonEmptyString;
- /**
- * The length of time, in minutes, that CloudFormation waits for the nested stack to reach the CREATE_COMPLETE state.
- */
- TimeoutInMinutes?: Integer;
- }
- export interface AwsCloudFormationStackDriftInformationDetails {
- /**
- * Status of the stack's actual configuration compared to its expected template configuration.
- */
- StackDriftStatus?: NonEmptyString;
- }
- export interface AwsCloudFormationStackOutputsDetails {
- /**
- * A user-defined description associated with the output.
- */
- Description?: NonEmptyString;
- /**
- * The key associated with the output.
- */
- OutputKey?: NonEmptyString;
- /**
- * The value associated with the output.
- */
- OutputValue?: NonEmptyString;
- }
- export type AwsCloudFormationStackOutputsList = AwsCloudFormationStackOutputsDetails[];
- export interface AwsCloudFrontDistributionCacheBehavior {
- /**
- * The protocol that viewers can use to access the files in an origin. You can specify the following options: allow-all - Viewers can use HTTP or HTTPS. redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit. https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).
- */
- ViewerProtocolPolicy?: NonEmptyString;
- }
- export interface AwsCloudFrontDistributionCacheBehaviors {
- /**
- * The cache behaviors for the distribution.
- */
- Items?: AwsCloudFrontDistributionCacheBehaviorsItemList;
- }
- export type AwsCloudFrontDistributionCacheBehaviorsItemList = AwsCloudFrontDistributionCacheBehavior[];
- export interface AwsCloudFrontDistributionDefaultCacheBehavior {
- /**
- * The protocol that viewers can use to access the files in an origin. You can specify the following options: allow-all - Viewers can use HTTP or HTTPS. redirect-to-https - CloudFront responds to HTTP requests with an HTTP status code of 301 (Moved Permanently) and the HTTPS URL. The viewer then uses the new URL to resubmit. https-only - CloudFront responds to HTTP request with an HTTP status code of 403 (Forbidden).
- */
- ViewerProtocolPolicy?: NonEmptyString;
- }
- export interface AwsCloudFrontDistributionDetails {
- /**
- * Provides information about the cache configuration for the distribution.
- */
- CacheBehaviors?: AwsCloudFrontDistributionCacheBehaviors;
- /**
- * The default cache behavior for the configuration.
- */
- DefaultCacheBehavior?: AwsCloudFrontDistributionDefaultCacheBehavior;
- /**
- * The object that CloudFront sends in response to requests from the origin (for example, index.html) when a viewer requests the root URL for the distribution (http://www.example.com) instead of an object in your distribution (http://www.example.com/product-description.html).
- */
- DefaultRootObject?: NonEmptyString;
- /**
- * The domain name corresponding to the distribution.
- */
- DomainName?: NonEmptyString;
- /**
- * The entity tag is a hash of the object.
- */
- ETag?: NonEmptyString;
- /**
- * Indicates when that the distribution was last modified. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastModifiedTime?: NonEmptyString;
- /**
- * A complex type that controls whether access logs are written for the distribution.
- */
- Logging?: AwsCloudFrontDistributionLogging;
- /**
- * A complex type that contains information about origins for this distribution.
- */
- Origins?: AwsCloudFrontDistributionOrigins;
- /**
- * Provides information about the origin groups in the distribution.
- */
- OriginGroups?: AwsCloudFrontDistributionOriginGroups;
- /**
- * Provides information about the TLS/SSL configuration that the distribution uses to communicate with viewers.
- */
- ViewerCertificate?: AwsCloudFrontDistributionViewerCertificate;
- /**
- * Indicates the current status of the distribution.
- */
- Status?: NonEmptyString;
- /**
- * A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution.
- */
- WebAclId?: NonEmptyString;
- }
- export interface AwsCloudFrontDistributionLogging {
- /**
- * The S3 bucket to store the access logs in.
- */
- Bucket?: NonEmptyString;
- /**
- * With this field, you can enable or disable the selected distribution.
- */
- Enabled?: Boolean;
- /**
- * Specifies whether you want CloudFront to include cookies in access logs.
- */
- IncludeCookies?: Boolean;
- /**
- * An optional string that you want CloudFront to use as a prefix to the access log filenames for this distribution.
- */
- Prefix?: NonEmptyString;
- }
- export interface AwsCloudFrontDistributionOriginCustomOriginConfig {
- /**
- * The HTTP port that CloudFront uses to connect to the origin.
- */
- HttpPort?: Integer;
- /**
- * The HTTPS port that CloudFront uses to connect to the origin.
- */
- HttpsPort?: Integer;
- /**
- * Specifies how long, in seconds, CloudFront persists its connection to the origin.
- */
- OriginKeepaliveTimeout?: Integer;
- /**
- * Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin.
- */
- OriginProtocolPolicy?: NonEmptyString;
- /**
- * Specifies how long, in seconds, CloudFront waits for a response from the origin.
- */
- OriginReadTimeout?: Integer;
- /**
- * Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS.
- */
- OriginSslProtocols?: AwsCloudFrontDistributionOriginSslProtocols;
- }
- export interface AwsCloudFrontDistributionOriginGroup {
- /**
- * Provides the criteria for an origin group to fail over.
- */
- FailoverCriteria?: AwsCloudFrontDistributionOriginGroupFailover;
- }
- export interface AwsCloudFrontDistributionOriginGroupFailover {
- /**
- * Information about the status codes that cause an origin group to fail over.
- */
- StatusCodes?: AwsCloudFrontDistributionOriginGroupFailoverStatusCodes;
- }
- export interface AwsCloudFrontDistributionOriginGroupFailoverStatusCodes {
- /**
- * The list of status code values that can cause a failover to the next origin.
- */
- Items?: AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList;
- /**
- * The number of status codes that can cause a failover.
- */
- Quantity?: Integer;
- }
- export type AwsCloudFrontDistributionOriginGroupFailoverStatusCodesItemList = Integer[];
- export interface AwsCloudFrontDistributionOriginGroups {
- /**
- * The list of origin groups.
- */
- Items?: AwsCloudFrontDistributionOriginGroupsItemList;
- }
- export type AwsCloudFrontDistributionOriginGroupsItemList = AwsCloudFrontDistributionOriginGroup[];
- export interface AwsCloudFrontDistributionOriginItem {
- /**
- * Amazon S3 origins: The DNS name of the S3 bucket from which you want CloudFront to get objects for this origin.
- */
- DomainName?: NonEmptyString;
- /**
- * A unique identifier for the origin or origin group.
- */
- Id?: NonEmptyString;
- /**
- * An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin.
- */
- OriginPath?: NonEmptyString;
- /**
- * An origin that is an S3 bucket that is not configured with static website hosting.
- */
- S3OriginConfig?: AwsCloudFrontDistributionOriginS3OriginConfig;
- /**
- * An origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this attribute. If the Amazon S3 bucket is not configured with static website hosting, use the S3OriginConfig type instead.
- */
- CustomOriginConfig?: AwsCloudFrontDistributionOriginCustomOriginConfig;
- }
- export type AwsCloudFrontDistributionOriginItemList = AwsCloudFrontDistributionOriginItem[];
- export interface AwsCloudFrontDistributionOriginS3OriginConfig {
- /**
- * The CloudFront origin access identity to associate with the origin.
- */
- OriginAccessIdentity?: NonEmptyString;
- }
- export interface AwsCloudFrontDistributionOriginSslProtocols {
- /**
- * A list that contains allowed SSL/TLS protocols for this distribution.
- */
- Items?: NonEmptyStringList;
- /**
- * The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin.
- */
- Quantity?: Integer;
- }
- export interface AwsCloudFrontDistributionOrigins {
- /**
- * A complex type that contains origins or origin groups for this distribution.
- */
- Items?: AwsCloudFrontDistributionOriginItemList;
- }
- export interface AwsCloudFrontDistributionViewerCertificate {
- /**
- * The ARN of the ACM certificate. Used if the certificate is stored in ACM. If you provide an ACM certificate ARN, you must also provide MinimumCertificateVersion and SslSupportMethod.
- */
- AcmCertificateArn?: NonEmptyString;
- /**
- * The identifier of the certificate. Note that in CloudFront, this attribute is deprecated.
- */
- Certificate?: NonEmptyString;
- /**
- * The source of the certificate identified by Certificate. Note that in CloudFront, this attribute is deprecated.
- */
- CertificateSource?: NonEmptyString;
- /**
- * Whether the distribution uses the CloudFront domain name. If set to false, then you provide either AcmCertificateArn or IamCertificateId.
- */
- CloudFrontDefaultCertificate?: Boolean;
- /**
- * The identifier of the IAM certificate. Used if the certificate is stored in IAM. If you provide IamCertificateId, then you also must provide MinimumProtocolVersion and SslSupportMethod.
- */
- IamCertificateId?: NonEmptyString;
- /**
- * The security policy that CloudFront uses for HTTPS connections with viewers. If SslSupportMethod is sni-only, then MinimumProtocolVersion must be TLSv1 or higher.
- */
- MinimumProtocolVersion?: NonEmptyString;
- /**
- * The viewers that the distribution accepts HTTPS connections from.
- */
- SslSupportMethod?: NonEmptyString;
- }
- export interface AwsCloudTrailTrailDetails {
- /**
- * The ARN of the log group that CloudTrail logs are delivered to.
- */
- CloudWatchLogsLogGroupArn?: NonEmptyString;
- /**
- * The ARN of the role that the CloudWatch Events endpoint assumes when it writes to the log group.
- */
- CloudWatchLogsRoleArn?: NonEmptyString;
- /**
- * Indicates whether the trail has custom event selectors.
- */
- HasCustomEventSelectors?: Boolean;
- /**
- * The Region where the trail was created.
- */
- HomeRegion?: NonEmptyString;
- /**
- * Indicates whether the trail publishes events from global services such as IAM to the log files.
- */
- IncludeGlobalServiceEvents?: Boolean;
- /**
- * Indicates whether the trail applies only to the current Region or to all Regions.
- */
- IsMultiRegionTrail?: Boolean;
- /**
- * Whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account.
- */
- IsOrganizationTrail?: Boolean;
- /**
- * The KMS key ID to use to encrypt the logs.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * Indicates whether CloudTrail log file validation is enabled.
- */
- LogFileValidationEnabled?: Boolean;
- /**
- * The name of the trail.
- */
- Name?: NonEmptyString;
- /**
- * The name of the S3 bucket where the log files are published.
- */
- S3BucketName?: NonEmptyString;
- /**
- * The S3 key prefix. The key prefix is added after the name of the S3 bucket where the log files are published.
- */
- S3KeyPrefix?: NonEmptyString;
- /**
- * The ARN of the SNS topic that is used for notifications of log file delivery.
- */
- SnsTopicArn?: NonEmptyString;
- /**
- * The name of the SNS topic that is used for notifications of log file delivery.
- */
- SnsTopicName?: NonEmptyString;
- /**
- * The ARN of the trail.
- */
- TrailArn?: NonEmptyString;
- }
- export interface AwsCloudWatchAlarmDetails {
- /**
- * Indicates whether actions should be executed during any changes to the alarm state.
- */
- ActionsEnabled?: Boolean;
- /**
- * The list of actions, specified as Amazon Resource Names (ARNs) to execute when this alarm transitions into an ALARM state from any other state.
- */
- AlarmActions?: NonEmptyStringList;
- /**
- * The ARN of the alarm.
- */
- AlarmArn?: NonEmptyString;
- /**
- * The time stamp of the last update to the alarm configuration.
- */
- AlarmConfigurationUpdatedTimestamp?: NonEmptyString;
- /**
- * The description of the alarm.
- */
- AlarmDescription?: NonEmptyString;
- /**
- * The name of the alarm. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the alarm name.
- */
- AlarmName?: NonEmptyString;
- /**
- * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
- */
- ComparisonOperator?: NonEmptyString;
- /**
- * The number of datapoints that must be breaching to trigger the alarm.
- */
- DatapointsToAlarm?: Integer;
- /**
- * The dimensions for the metric associated with the alarm.
- */
- Dimensions?: AwsCloudWatchAlarmDimensionsList;
- /**
- * Used only for alarms based on percentiles. If ignore, the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
- */
- EvaluateLowSampleCountPercentile?: NonEmptyString;
- /**
- * The number of periods over which data is compared to the specified threshold.
- */
- EvaluationPeriods?: Integer;
- /**
- * The percentile statistic for the metric associated with the alarm.
- */
- ExtendedStatistic?: NonEmptyString;
- /**
- * The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.
- */
- InsufficientDataActions?: NonEmptyStringList;
- /**
- * The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName.
- */
- MetricName?: NonEmptyString;
- /**
- * The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.
- */
- Namespace?: NonEmptyString;
- /**
- * The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an ARN.
- */
- OkActions?: NonEmptyStringList;
- /**
- * The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric.
- */
- Period?: Integer;
- /**
- * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic. For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both. For an alarm based on a math expression, you can't specify Statistic. Instead, you use Metrics.
- */
- Statistic?: NonEmptyString;
- /**
- * The value to compare with the specified statistic.
- */
- Threshold?: Double;
- /**
- * n an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
- */
- ThresholdMetricId?: NonEmptyString;
- /**
- * Sets how this alarm is to handle missing data points.
- */
- TreatMissingData?: NonEmptyString;
- /**
- * The unit of the metric associated with the alarm.
- */
- Unit?: NonEmptyString;
- }
- export interface AwsCloudWatchAlarmDimensionsDetails {
- /**
- * The name of a dimension.
- */
- Name?: NonEmptyString;
- /**
- * The value of a dimension.
- */
- Value?: NonEmptyString;
- }
- export type AwsCloudWatchAlarmDimensionsList = AwsCloudWatchAlarmDimensionsDetails[];
- export interface AwsCodeBuildProjectArtifactsDetails {
- /**
- * An identifier for the artifact definition.
- */
- ArtifactIdentifier?: NonEmptyString;
- /**
- * Indicates whether to disable encryption on the artifact. Only valid when Type is S3.
- */
- EncryptionDisabled?: Boolean;
- /**
- * Only used when Type is S3. The name of the S3 bucket where the artifact is located.
- */
- Location?: NonEmptyString;
- /**
- * Only used when Type is S3. The name of the artifact. Used with NamepaceType and Path to determine the pattern for storing the artifact.
- */
- Name?: NonEmptyString;
- /**
- * Only used when Type is S3. The value to use for the namespace. Used with Name and Path to determine the pattern for storing the artifact.
- */
- NamespaceType?: NonEmptyString;
- /**
- * Whether the name specified in the buildspec file overrides the artifact name.
- */
- OverrideArtifactName?: Boolean;
- /**
- * Only used when Type is S3. The type of output artifact to create.
- */
- Packaging?: NonEmptyString;
- /**
- * Only used when Type is S3. The path to the artifact. Used with Name and NamespaceType to determine the pattern for storing the artifact.
- */
- Path?: NonEmptyString;
- /**
- * The type of build artifact.
- */
- Type?: NonEmptyString;
- }
- export type AwsCodeBuildProjectArtifactsList = AwsCodeBuildProjectArtifactsDetails[];
- export interface AwsCodeBuildProjectDetails {
- /**
- * The KMS key used to encrypt the build output artifacts. You can specify either the ARN of the KMS key or, if available, the KMS key alias (using the format alias/alias-name).
- */
- EncryptionKey?: NonEmptyString;
- /**
- * Information about the build artifacts for the CodeBuild project.
- */
- Artifacts?: AwsCodeBuildProjectArtifactsList;
- /**
- * Information about the build environment for this build project.
- */
- Environment?: AwsCodeBuildProjectEnvironment;
- /**
- * The name of the build project.
- */
- Name?: NonEmptyString;
- /**
- * Information about the build input source code for this build project.
- */
- Source?: AwsCodeBuildProjectSource;
- /**
- * The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.
- */
- ServiceRole?: NonEmptyString;
- /**
- * Information about logs for the build project.
- */
- LogsConfig?: AwsCodeBuildProjectLogsConfigDetails;
- /**
- * Information about the VPC configuration that CodeBuild accesses.
- */
- VpcConfig?: AwsCodeBuildProjectVpcConfig;
- /**
- * Information about the secondary artifacts for the CodeBuild project.
- */
- SecondaryArtifacts?: AwsCodeBuildProjectArtifactsList;
- }
- export interface AwsCodeBuildProjectEnvironment {
- /**
- * The certificate to use with this build project.
- */
- Certificate?: NonEmptyString;
- /**
- * A set of environment variables to make available to builds for the build project.
- */
- EnvironmentVariables?: AwsCodeBuildProjectEnvironmentEnvironmentVariablesList;
- /**
- * Whether to allow the Docker daemon to run inside a Docker container. Set to true if the build project is used to build Docker images.
- */
- PrivilegedMode?: Boolean;
- /**
- * The type of credentials CodeBuild uses to pull images in your build. Valid values: CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust the CodeBuild service principal. SERVICE_ROLE specifies that CodeBuild uses your build project's service role. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.
- */
- ImagePullCredentialsType?: NonEmptyString;
- /**
- * The credentials for access to a private registry.
- */
- RegistryCredential?: AwsCodeBuildProjectEnvironmentRegistryCredential;
- /**
- * The type of build environment to use for related builds. The environment type ARM_CONTAINER is available only in Regions US East (N. Virginia), US East (Ohio), US West (Oregon), Europe (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and Europe (Frankfurt). The environment type LINUX_CONTAINER with compute type build.general1.2xlarge is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). The environment type LINUX_GPU_CONTAINER is available only in Regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), Europe (Ireland), Europe (London), Europe (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). Valid values: WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER
- */
- Type?: NonEmptyString;
- }
- export interface AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails {
- /**
- * The name of the environment variable.
- */
- Name?: NonEmptyString;
- /**
- * The type of environment variable.
- */
- Type?: NonEmptyString;
- /**
- * The value of the environment variable.
- */
- Value?: NonEmptyString;
- }
- export type AwsCodeBuildProjectEnvironmentEnvironmentVariablesList = AwsCodeBuildProjectEnvironmentEnvironmentVariablesDetails[];
- export interface AwsCodeBuildProjectEnvironmentRegistryCredential {
- /**
- * The ARN or name of credentials created using Secrets Manager. The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.
- */
- Credential?: NonEmptyString;
- /**
- * The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.
- */
- CredentialProvider?: NonEmptyString;
- }
- export interface AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails {
- /**
- * The group name of the logs in CloudWatch Logs.
- */
- GroupName?: NonEmptyString;
- /**
- * The current status of the logs in CloudWatch Logs for a build project.
- */
- Status?: NonEmptyString;
- /**
- * The prefix of the stream name of the CloudWatch Logs.
- */
- StreamName?: NonEmptyString;
- }
- export interface AwsCodeBuildProjectLogsConfigDetails {
- /**
- * Information about CloudWatch Logs for the build project.
- */
- CloudWatchLogs?: AwsCodeBuildProjectLogsConfigCloudWatchLogsDetails;
- /**
- * Information about logs built to an S3 bucket for a build project.
- */
- S3Logs?: AwsCodeBuildProjectLogsConfigS3LogsDetails;
- }
- export interface AwsCodeBuildProjectLogsConfigS3LogsDetails {
- /**
- * Whether to disable encryption of the S3 build log output.
- */
- EncryptionDisabled?: Boolean;
- /**
- * The ARN of the S3 bucket and the path prefix for S3 logs.
- */
- Location?: NonEmptyString;
- /**
- * The current status of the S3 build logs.
- */
- Status?: NonEmptyString;
- }
- export interface AwsCodeBuildProjectSource {
- /**
- * The type of repository that contains the source code to be built. Valid values are: BITBUCKET - The source code is in a Bitbucket repository. CODECOMMIT - The source code is in an CodeCommit repository. CODEPIPELINE - The source code settings are specified in the source action of a pipeline in CodePipeline. GITHUB - The source code is in a GitHub repository. GITHUB_ENTERPRISE - The source code is in a GitHub Enterprise repository. NO_SOURCE - The project does not have input source code. S3 - The source code is in an S3 input bucket.
- */
- Type?: NonEmptyString;
- /**
- * Information about the location of the source code to be built. Valid values include: For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value. For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec file (for example, https://git-codecommit.region-ID.amazonaws.com/v1/repos/repo-name ). For source code in an S3 input bucket, one of the following. The path to the ZIP file that contains the source code (for example, bucket-name/path/to/object-name.zip). The path to the folder that contains the source code (for example, bucket-name/path/to/source-code/folder/). For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec file. For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec file.
- */
- Location?: NonEmptyString;
- /**
- * Information about the Git clone depth for the build project.
- */
- GitCloneDepth?: Integer;
- /**
- * Whether to ignore SSL warnings while connecting to the project source code.
- */
- InsecureSsl?: Boolean;
- }
- export interface AwsCodeBuildProjectVpcConfig {
- /**
- * The ID of the VPC.
- */
- VpcId?: NonEmptyString;
- /**
- * A list of one or more subnet IDs in your VPC.
- */
- Subnets?: NonEmptyStringList;
- /**
- * A list of one or more security group IDs in your VPC.
- */
- SecurityGroupIds?: NonEmptyStringList;
- }
- export interface AwsCorsConfiguration {
- /**
- * The allowed origins for CORS requests.
- */
- AllowOrigins?: NonEmptyStringList;
- /**
- * Indicates whether the CORS request includes credentials.
- */
- AllowCredentials?: Boolean;
- /**
- * The exposed headers for CORS requests.
- */
- ExposeHeaders?: NonEmptyStringList;
- /**
- * The number of seconds for which the browser caches preflight request results.
- */
- MaxAge?: Integer;
- /**
- * The allowed methods for CORS requests.
- */
- AllowMethods?: NonEmptyStringList;
- /**
- * The allowed headers for CORS requests.
- */
- AllowHeaders?: NonEmptyStringList;
- }
- export interface AwsDmsEndpointDetails {
- /**
- * The Amazon Resource Name (ARN) for the SSL certificate that encrypts connections between the DMS endpoint and the replication instance.
- */
- CertificateArn?: NonEmptyString;
- /**
- * The name of the endpoint database.
- */
- DatabaseName?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the endpoint.
- */
- EndpointArn?: NonEmptyString;
- /**
- * The database endpoint identifier.
- */
- EndpointIdentifier?: NonEmptyString;
- /**
- * The type of endpoint. Valid values are source and target.
- */
- EndpointType?: NonEmptyString;
- /**
- * The type of engine for the endpoint, depending on the EndpointType value.
- */
- EngineName?: NonEmptyString;
- /**
- * A value that can be used for cross-account validation.
- */
- ExternalId?: NonEmptyString;
- /**
- * Additional attributes associated with the connection.
- */
- ExtraConnectionAttributes?: NonEmptyString;
- /**
- * An DMS key identifier that is used to encrypt the connection parameters for the endpoint. If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The port used to access the endpoint.
- */
- Port?: Integer;
- /**
- * The name of the server where the endpoint database resides.
- */
- ServerName?: NonEmptyString;
- /**
- * The SSL mode used to connect to the endpoint. The default is none.
- */
- SslMode?: NonEmptyString;
- /**
- * The user name to be used to log in to the endpoint database.
- */
- Username?: NonEmptyString;
- }
- export interface AwsDmsReplicationInstanceDetails {
- /**
- * The amount of storage (in gigabytes) that is allocated for the replication instance.
- */
- AllocatedStorage?: Integer;
- /**
- * Indicates whether minor engine upgrades are applied automatically to the replication instance during the maintenance window.
- */
- AutoMinorVersionUpgrade?: Boolean;
- /**
- * The Availability Zone that the replication instance is created in. The default value is a random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region, such as us-east-1d.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * The engine version number of the replication instance. If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.
- */
- EngineVersion?: NonEmptyString;
- /**
- * An KMS key identifier that is used to encrypt the data on the replication instance. If you don't specify a value for the KmsKeyId parameter, DMS uses your default encryption key. KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * Specifies whether the replication instance is deployed across multiple Availability Zones (AZs). You can't set the AvailabilityZone parameter if the MultiAZ parameter is set to true.
- */
- MultiAZ?: Boolean;
- /**
- * The maintenance window times for the replication instance. Upgrades to the replication instance are performed during this time.
- */
- PreferredMaintenanceWindow?: NonEmptyString;
- /**
- * Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.
- */
- PubliclyAccessible?: Boolean;
- /**
- * The compute and memory capacity of the replication instance as defined for the specified replication instance class.
- */
- ReplicationInstanceClass?: NonEmptyString;
- /**
- * The replication instance identifier.
- */
- ReplicationInstanceIdentifier?: NonEmptyString;
- /**
- * The subnet group for the replication instance.
- */
- ReplicationSubnetGroup?: AwsDmsReplicationInstanceReplicationSubnetGroupDetails;
- /**
- * The virtual private cloud (VPC) security group for the replication instance.
- */
- VpcSecurityGroups?: AwsDmsReplicationInstanceVpcSecurityGroupsList;
- }
- export interface AwsDmsReplicationInstanceReplicationSubnetGroupDetails {
- /**
- * The identifier of the replication subnet group.
- */
- ReplicationSubnetGroupIdentifier?: NonEmptyString;
- }
- export interface AwsDmsReplicationInstanceVpcSecurityGroupsDetails {
- /**
- * The identifier of the VPC security group that’s associated with the replication instance.
- */
- VpcSecurityGroupId?: NonEmptyString;
- }
- export type AwsDmsReplicationInstanceVpcSecurityGroupsList = AwsDmsReplicationInstanceVpcSecurityGroupsDetails[];
- export interface AwsDmsReplicationTaskDetails {
- /**
- * Indicates when you want a change data capture (CDC) operation to start. CCdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.
- */
- CdcStartPosition?: NonEmptyString;
- /**
- * Indicates the start time for a CDC operation. CdcStartPosition or CCdcStartTime specifies when you want a CDC operation to start. Only a value for one of these fields is included.
- */
- CdcStartTime?: NonEmptyString;
- /**
- * Indicates when you want a CDC operation to stop. The value can be either server time or commit time.
- */
- CdcStopPosition?: NonEmptyString;
- /**
- * The migration type.
- */
- MigrationType?: NonEmptyString;
- /**
- * The identifier of the replication task.
- */
- Id?: NonEmptyString;
- /**
- * A display name for the resource identifier at the end of the EndpointArn response parameter. If you don't specify a ResourceIdentifier value, DMS generates a default identifier value for the end of EndpointArn.
- */
- ResourceIdentifier?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of a replication instance.
- */
- ReplicationInstanceArn?: NonEmptyString;
- /**
- * The user-defined replication task identifier or name.
- */
- ReplicationTaskIdentifier?: NonEmptyString;
- /**
- * The settings for the replication task.
- */
- ReplicationTaskSettings?: NonEmptyString;
- /**
- * The ARN of the source endpoint.
- */
- SourceEndpointArn?: NonEmptyString;
- /**
- * The table mappings for the replication task, in JSON format.
- */
- TableMappings?: NonEmptyString;
- /**
- * The ARN of the target endpoint.
- */
- TargetEndpointArn?: NonEmptyString;
- /**
- * Supplemental information that the task requires to migrate the data for certain source and target endpoints.
- */
- TaskData?: NonEmptyString;
- }
- export interface AwsDynamoDbTableAttributeDefinition {
- /**
- * The name of the attribute.
- */
- AttributeName?: NonEmptyString;
- /**
- * The type of the attribute.
- */
- AttributeType?: NonEmptyString;
- }
- export type AwsDynamoDbTableAttributeDefinitionList = AwsDynamoDbTableAttributeDefinition[];
- export interface AwsDynamoDbTableBillingModeSummary {
- /**
- * The method used to charge for read and write throughput and to manage capacity.
- */
- BillingMode?: NonEmptyString;
- /**
- * If the billing mode is PAY_PER_REQUEST, indicates when the billing mode was set to that value. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastUpdateToPayPerRequestDateTime?: NonEmptyString;
- }
- export interface AwsDynamoDbTableDetails {
- /**
- * A list of attribute definitions for the table.
- */
- AttributeDefinitions?: AwsDynamoDbTableAttributeDefinitionList;
- /**
- * Information about the billing for read/write capacity on the table.
- */
- BillingModeSummary?: AwsDynamoDbTableBillingModeSummary;
- /**
- * Indicates when the table was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreationDateTime?: NonEmptyString;
- /**
- * List of global secondary indexes for the table.
- */
- GlobalSecondaryIndexes?: AwsDynamoDbTableGlobalSecondaryIndexList;
- /**
- * The version of global tables being used.
- */
- GlobalTableVersion?: NonEmptyString;
- /**
- * The number of items in the table.
- */
- ItemCount?: Integer;
- /**
- * The primary key structure for the table.
- */
- KeySchema?: AwsDynamoDbTableKeySchemaList;
- /**
- * The ARN of the latest stream for the table.
- */
- LatestStreamArn?: NonEmptyString;
- /**
- * The label of the latest stream. The label is not a unique identifier.
- */
- LatestStreamLabel?: NonEmptyString;
- /**
- * The list of local secondary indexes for the table.
- */
- LocalSecondaryIndexes?: AwsDynamoDbTableLocalSecondaryIndexList;
- /**
- * Information about the provisioned throughput for the table.
- */
- ProvisionedThroughput?: AwsDynamoDbTableProvisionedThroughput;
- /**
- * The list of replicas of this table.
- */
- Replicas?: AwsDynamoDbTableReplicaList;
- /**
- * Information about the restore for the table.
- */
- RestoreSummary?: AwsDynamoDbTableRestoreSummary;
- /**
- * Information about the server-side encryption for the table.
- */
- SseDescription?: AwsDynamoDbTableSseDescription;
- /**
- * The current DynamoDB Streams configuration for the table.
- */
- StreamSpecification?: AwsDynamoDbTableStreamSpecification;
- /**
- * The identifier of the table.
- */
- TableId?: NonEmptyString;
- /**
- * The name of the table.
- */
- TableName?: NonEmptyString;
- /**
- * The total size of the table in bytes.
- */
- TableSizeBytes?: SizeBytes;
- /**
- * The current status of the table. Valid values are as follows: ACTIVE ARCHIVED ARCHIVING CREATING DELETING INACCESSIBLE_ENCRYPTION_CREDENTIALS UPDATING
- */
- TableStatus?: NonEmptyString;
- /**
- * Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.
- */
- DeletionProtectionEnabled?: Boolean;
- }
- export interface AwsDynamoDbTableGlobalSecondaryIndex {
- /**
- * Whether the index is currently backfilling.
- */
- Backfilling?: Boolean;
- /**
- * The ARN of the index.
- */
- IndexArn?: NonEmptyString;
- /**
- * The name of the index.
- */
- IndexName?: NonEmptyString;
- /**
- * The total size in bytes of the index.
- */
- IndexSizeBytes?: SizeBytes;
- /**
- * The current status of the index. ACTIVE CREATING DELETING UPDATING
- */
- IndexStatus?: NonEmptyString;
- /**
- * The number of items in the index.
- */
- ItemCount?: Integer;
- /**
- * The key schema for the index.
- */
- KeySchema?: AwsDynamoDbTableKeySchemaList;
- /**
- * Attributes that are copied from the table into an index.
- */
- Projection?: AwsDynamoDbTableProjection;
- /**
- * Information about the provisioned throughput settings for the indexes.
- */
- ProvisionedThroughput?: AwsDynamoDbTableProvisionedThroughput;
- }
- export type AwsDynamoDbTableGlobalSecondaryIndexList = AwsDynamoDbTableGlobalSecondaryIndex[];
- export interface AwsDynamoDbTableKeySchema {
- /**
- * The name of the key schema attribute.
- */
- AttributeName?: NonEmptyString;
- /**
- * The type of key used for the key schema attribute. Valid values are HASH or RANGE.
- */
- KeyType?: NonEmptyString;
- }
- export type AwsDynamoDbTableKeySchemaList = AwsDynamoDbTableKeySchema[];
- export interface AwsDynamoDbTableLocalSecondaryIndex {
- /**
- * The ARN of the index.
- */
- IndexArn?: NonEmptyString;
- /**
- * The name of the index.
- */
- IndexName?: NonEmptyString;
- /**
- * The complete key schema for the index.
- */
- KeySchema?: AwsDynamoDbTableKeySchemaList;
- /**
- * Attributes that are copied from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected.
- */
- Projection?: AwsDynamoDbTableProjection;
- }
- export type AwsDynamoDbTableLocalSecondaryIndexList = AwsDynamoDbTableLocalSecondaryIndex[];
- export interface AwsDynamoDbTableProjection {
- /**
- * The nonkey attributes that are projected into the index. For each attribute, provide the attribute name.
- */
- NonKeyAttributes?: StringList;
- /**
- * The types of attributes that are projected into the index. Valid values are as follows: ALL INCLUDE KEYS_ONLY
- */
- ProjectionType?: NonEmptyString;
- }
- export interface AwsDynamoDbTableProvisionedThroughput {
- /**
- * Indicates when the provisioned throughput was last decreased. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastDecreaseDateTime?: NonEmptyString;
- /**
- * Indicates when the provisioned throughput was last increased. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastIncreaseDateTime?: NonEmptyString;
- /**
- * The number of times during the current UTC calendar day that the provisioned throughput was decreased.
- */
- NumberOfDecreasesToday?: Integer;
- /**
- * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ThrottlingException.
- */
- ReadCapacityUnits?: Integer;
- /**
- * The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.
- */
- WriteCapacityUnits?: Integer;
- }
- export interface AwsDynamoDbTableProvisionedThroughputOverride {
- /**
- * The read capacity units for the replica.
- */
- ReadCapacityUnits?: Integer;
- }
- export interface AwsDynamoDbTableReplica {
- /**
- * List of global secondary indexes for the replica.
- */
- GlobalSecondaryIndexes?: AwsDynamoDbTableReplicaGlobalSecondaryIndexList;
- /**
- * The identifier of the KMS key that will be used for KMS encryption for the replica.
- */
- KmsMasterKeyId?: NonEmptyString;
- /**
- * Replica-specific configuration for the provisioned throughput.
- */
- ProvisionedThroughputOverride?: AwsDynamoDbTableProvisionedThroughputOverride;
- /**
- * The name of the Region where the replica is located.
- */
- RegionName?: NonEmptyString;
- /**
- * The current status of the replica. Valid values are as follows: ACTIVE CREATING CREATION_FAILED DELETING UPDATING
- */
- ReplicaStatus?: NonEmptyString;
- /**
- * Detailed information about the replica status.
- */
- ReplicaStatusDescription?: NonEmptyString;
- }
- export interface AwsDynamoDbTableReplicaGlobalSecondaryIndex {
- /**
- * The name of the index.
- */
- IndexName?: NonEmptyString;
- /**
- * Replica-specific configuration for the provisioned throughput for the index.
- */
- ProvisionedThroughputOverride?: AwsDynamoDbTableProvisionedThroughputOverride;
- }
- export type AwsDynamoDbTableReplicaGlobalSecondaryIndexList = AwsDynamoDbTableReplicaGlobalSecondaryIndex[];
- export type AwsDynamoDbTableReplicaList = AwsDynamoDbTableReplica[];
- export interface AwsDynamoDbTableRestoreSummary {
- /**
- * The ARN of the source backup from which the table was restored.
- */
- SourceBackupArn?: NonEmptyString;
- /**
- * The ARN of the source table for the backup.
- */
- SourceTableArn?: NonEmptyString;
- /**
- * Indicates the point in time that the table was restored to. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- RestoreDateTime?: NonEmptyString;
- /**
- * Whether a restore is currently in progress.
- */
- RestoreInProgress?: Boolean;
- }
- export interface AwsDynamoDbTableSseDescription {
- /**
- * If the key is inaccessible, the date and time when DynamoDB detected that the key was inaccessible. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- InaccessibleEncryptionDateTime?: NonEmptyString;
- /**
- * The status of the server-side encryption.
- */
- Status?: NonEmptyString;
- /**
- * The type of server-side encryption.
- */
- SseType?: NonEmptyString;
- /**
- * The ARN of the KMS key that is used for the KMS encryption.
- */
- KmsMasterKeyArn?: NonEmptyString;
- }
- export interface AwsDynamoDbTableStreamSpecification {
- /**
- * Indicates whether DynamoDB Streams is enabled on the table.
- */
- StreamEnabled?: Boolean;
- /**
- * Determines the information that is written to the table.
- */
- StreamViewType?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails {
- /**
- * The ID of the Active Directory used for authentication.
- */
- DirectoryId?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointAuthenticationOptionsDetails {
- /**
- * The authentication type used.
- */
- Type?: NonEmptyString;
- /**
- * Information about the Active Directory, if applicable. With Active Directory authentication, clients are authenticated against existing Active Directory groups.
- */
- ActiveDirectory?: AwsEc2ClientVpnEndpointAuthenticationOptionsActiveDirectoryDetails;
- /**
- * Information about the authentication certificates, if applicable.
- */
- MutualAuthentication?: AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails;
- /**
- * Information about the IAM SAML identity provider, if applicable.
- */
- FederatedAuthentication?: AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails;
- }
- export interface AwsEc2ClientVpnEndpointAuthenticationOptionsFederatedAuthenticationDetails {
- /**
- * The Amazon Resource Name (ARN) of the IAM SAML identity provider.
- */
- SamlProviderArn?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.
- */
- SelfServiceSamlProviderArn?: NonEmptyString;
- }
- export type AwsEc2ClientVpnEndpointAuthenticationOptionsList = AwsEc2ClientVpnEndpointAuthenticationOptionsDetails[];
- export interface AwsEc2ClientVpnEndpointAuthenticationOptionsMutualAuthenticationDetails {
- /**
- * The Amazon Resource Name (ARN) of the client certificate.
- */
- ClientRootCertificateChain?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointClientConnectOptionsDetails {
- /**
- * Indicates whether client connect options are enabled.
- */
- Enabled?: Boolean;
- /**
- * The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
- */
- LambdaFunctionArn?: NonEmptyString;
- /**
- * The status of any updates to the client connect options.
- */
- Status?: AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails;
- }
- export interface AwsEc2ClientVpnEndpointClientConnectOptionsStatusDetails {
- /**
- * The status code.
- */
- Code?: NonEmptyString;
- /**
- * The status message.
- */
- Message?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails {
- /**
- * Current state of text banner feature.
- */
- Enabled?: Boolean;
- /**
- * Customizable text that will be displayed in a banner on Amazon Web Services provided clients when a VPN session is established.
- */
- BannerText?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointConnectionLogOptionsDetails {
- /**
- * Indicates whether client connection logging is enabled for the Client VPN endpoint.
- */
- Enabled?: Boolean;
- /**
- * The name of the Amazon CloudWatch Logs log group to which connection logging data is published.
- */
- CloudwatchLogGroup?: NonEmptyString;
- /**
- * The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.
- */
- CloudwatchLogStream?: NonEmptyString;
- }
- export interface AwsEc2ClientVpnEndpointDetails {
- /**
- * The ID of the Client VPN endpoint.
- */
- ClientVpnEndpointId?: NonEmptyString;
- /**
- * A brief description of the endpoint.
- */
- Description?: NonEmptyString;
- /**
- * The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
- */
- ClientCidrBlock?: NonEmptyString;
- /**
- * Information about the DNS servers to be used for DNS resolution.
- */
- DnsServer?: StringList;
- /**
- * Indicates whether split-tunnel is enabled in the Client VPN endpoint.
- */
- SplitTunnel?: Boolean;
- /**
- * The transport protocol used by the Client VPN endpoint.
- */
- TransportProtocol?: NonEmptyString;
- /**
- * The port number for the Client VPN endpoint.
- */
- VpnPort?: Integer;
- /**
- * The Amazon Resource Name (ARN) of the server certificate.
- */
- ServerCertificateArn?: NonEmptyString;
- /**
- * Information about the authentication method used by the Client VPN endpoint.
- */
- AuthenticationOptions?: AwsEc2ClientVpnEndpointAuthenticationOptionsList;
- /**
- * Information about the client connection logging options for the Client VPN endpoint.
- */
- ConnectionLogOptions?: AwsEc2ClientVpnEndpointConnectionLogOptionsDetails;
- /**
- * The IDs of the security groups for the target network.
- */
- SecurityGroupIdSet?: StringList;
- /**
- * The ID of the VPC.
- */
- VpcId?: NonEmptyString;
- /**
- * The URL of the self-service portal.
- */
- SelfServicePortalUrl?: NonEmptyString;
- /**
- * The options for managing connection authorization for new client connections.
- */
- ClientConnectOptions?: AwsEc2ClientVpnEndpointClientConnectOptionsDetails;
- /**
- * The maximum VPN session duration time in hours.
- */
- SessionTimeoutHours?: Integer;
- /**
- * Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
- */
- ClientLoginBannerOptions?: AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails;
- }
- export interface AwsEc2EipDetails {
- /**
- * The identifier of the EC2 instance.
- */
- InstanceId?: NonEmptyString;
- /**
- * A public IP address that is associated with the EC2 instance.
- */
- PublicIp?: NonEmptyString;
- /**
- * The identifier that Amazon Web Services assigns to represent the allocation of the Elastic IP address for use with Amazon VPC.
- */
- AllocationId?: NonEmptyString;
- /**
- * The identifier that represents the association of the Elastic IP address with an EC2 instance.
- */
- AssociationId?: NonEmptyString;
- /**
- * The domain in which to allocate the address. If the address is for use with EC2 instances in a VPC, then Domain is vpc. Otherwise, Domain is standard.
- */
- Domain?: NonEmptyString;
- /**
- * The identifier of an IP address pool. This parameter allows Amazon EC2 to select an IP address from the address pool.
- */
- PublicIpv4Pool?: NonEmptyString;
- /**
- * The name of the location from which the Elastic IP address is advertised.
- */
- NetworkBorderGroup?: NonEmptyString;
- /**
- * The identifier of the network interface.
- */
- NetworkInterfaceId?: NonEmptyString;
- /**
- * The Amazon Web Services account ID of the owner of the network interface.
- */
- NetworkInterfaceOwnerId?: NonEmptyString;
- /**
- * The private IP address that is associated with the Elastic IP address.
- */
- PrivateIpAddress?: NonEmptyString;
- }
- export interface AwsEc2InstanceDetails {
- /**
- * The instance type of the instance.
- */
- Type?: NonEmptyString;
- /**
- * The Amazon Machine Image (AMI) ID of the instance.
- */
- ImageId?: NonEmptyString;
- /**
- * The IPv4 addresses associated with the instance.
- */
- IpV4Addresses?: StringList;
- /**
- * The IPv6 addresses associated with the instance.
- */
- IpV6Addresses?: StringList;
- /**
- * The key name associated with the instance.
- */
- KeyName?: NonEmptyString;
- /**
- * The IAM profile ARN of the instance.
- */
- IamInstanceProfileArn?: NonEmptyString;
- /**
- * The identifier of the VPC that the instance was launched in.
- */
- VpcId?: NonEmptyString;
- /**
- * The identifier of the subnet that the instance was launched in.
- */
- SubnetId?: NonEmptyString;
- /**
- * Indicates when the instance was launched. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LaunchedAt?: NonEmptyString;
- /**
- * The identifiers of the network interfaces for the EC2 instance. The details for each network interface are in a corresponding AwsEc2NetworkInterfacesDetails object.
- */
- NetworkInterfaces?: AwsEc2InstanceNetworkInterfacesList;
- /**
- * The virtualization type of the Amazon Machine Image (AMI) required to launch the instance.
- */
- VirtualizationType?: NonEmptyString;
- /**
- * Details about the metadata options for the Amazon EC2 instance.
- */
- MetadataOptions?: AwsEc2InstanceMetadataOptions;
- /**
- * Describes the type of monitoring that’s turned on for an instance.
- */
- Monitoring?: AwsEc2InstanceMonitoringDetails;
- }
- export interface AwsEc2InstanceMetadataOptions {
- /**
- * Enables or disables the HTTP metadata endpoint on the instance.
- */
- HttpEndpoint?: NonEmptyString;
- /**
- * Enables or disables the IPv6 endpoint for the instance metadata service.
- */
- HttpProtocolIpv6?: NonEmptyString;
- /**
- * The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
- */
- HttpPutResponseHopLimit?: Integer;
- /**
- * The state of token usage for your instance metadata requests.
- */
- HttpTokens?: NonEmptyString;
- /**
- * Specifies whether to allow access to instance tags from the instance metadata.
- */
- InstanceMetadataTags?: NonEmptyString;
- }
- export interface AwsEc2InstanceMonitoringDetails {
- /**
- * Indicates whether detailed monitoring is turned on. Otherwise, basic monitoring is turned on.
- */
- State?: NonEmptyString;
- }
- export interface AwsEc2InstanceNetworkInterfacesDetails {
- /**
- * The identifier of the network interface. The details are in a corresponding AwsEc2NetworkInterfacesDetails object.
- */
- NetworkInterfaceId?: NonEmptyString;
- }
- export type AwsEc2InstanceNetworkInterfacesList = AwsEc2InstanceNetworkInterfacesDetails[];
- export interface AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails {
- /**
- * The device name.
- */
- DeviceName?: NonEmptyString;
- /**
- * Parameters used to automatically set up Amazon EBS volumes when the instance is launched.
- */
- Ebs?: AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails;
- /**
- * Omits the device from the block device mapping when an empty string is specified.
- */
- NoDevice?: NonEmptyString;
- /**
- * The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type.
- */
- VirtualName?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataBlockDeviceMappingSetEbsDetails {
- /**
- * Indicates whether the EBS volume is deleted on instance termination.
- */
- DeleteOnTermination?: Boolean;
- /**
- * Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you're creating a volume from a snapshot, you can't specify an encryption value.
- */
- Encrypted?: Boolean;
- /**
- * The number of I/O operations per second (IOPS).
- */
- Iops?: Integer;
- /**
- * The Amazon Resource Name (ARN) of the symmetric Key Management Service (KMS) customer managed key used for encryption.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The ID of the EBS snapshot.
- */
- SnapshotId?: NonEmptyString;
- /**
- * The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
- */
- Throughput?: Integer;
- /**
- * The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size.
- */
- VolumeSize?: Integer;
- /**
- * The volume type.
- */
- VolumeType?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataBlockDeviceMappingSetList = AwsEc2LaunchTemplateDataBlockDeviceMappingSetDetails[];
- export interface AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails {
- /**
- * The ID of the Capacity Reservation in which to run the instance.
- */
- CapacityReservationId?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the Capacity Reservation resource group in which to run the instance.
- */
- CapacityReservationResourceGroupArn?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails {
- /**
- * Indicates the instance's Capacity Reservation preferences. If equal to open, the instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). If equal to none, the instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
- */
- CapacityReservationPreference?: NonEmptyString;
- /**
- * Specifies a target Capacity Reservation.
- */
- CapacityReservationTarget?: AwsEc2LaunchTemplateDataCapacityReservationSpecificationCapacityReservationTargetDetails;
- }
- export interface AwsEc2LaunchTemplateDataCpuOptionsDetails {
- /**
- * The number of CPU cores for the instance.
- */
- CoreCount?: Integer;
- /**
- * The number of threads per CPU core. A value of 1 disables multithreading for the instance, The default value is 2.
- */
- ThreadsPerCore?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataCreditSpecificationDetails {
- /**
- * The credit option for CPU usage of a T instance.
- */
- CpuCredits?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataDetails {
- /**
- * Information about a block device mapping for an Amazon EC2 launch template.
- */
- BlockDeviceMappingSet?: AwsEc2LaunchTemplateDataBlockDeviceMappingSetList;
- /**
- * Specifies an instance's Capacity Reservation targeting option. You can specify only one option at a time.
- */
- CapacityReservationSpecification?: AwsEc2LaunchTemplateDataCapacityReservationSpecificationDetails;
- /**
- * Specifies the CPU options for an instance. For more information, see Optimize CPU options in the Amazon Elastic Compute Cloud User Guide.
- */
- CpuOptions?: AwsEc2LaunchTemplateDataCpuOptionsDetails;
- /**
- * Specifies the credit option for CPU usage of a T2, T3, or T3a instance.
- */
- CreditSpecification?: AwsEc2LaunchTemplateDataCreditSpecificationDetails;
- /**
- * Indicates whether to enable the instance for stop protection. For more information, see Enable stop protection in the Amazon EC2 User Guide.
- */
- DisableApiStop?: Boolean;
- /**
- * If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API. If set to true, you can.
- */
- DisableApiTermination?: Boolean;
- /**
- * Indicates whether the instance is optimized for Amazon EBS I/O.
- */
- EbsOptimized?: Boolean;
- /**
- * Provides details about Elastic Graphics accelerators to associate with the instance.
- */
- ElasticGpuSpecificationSet?: AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList;
- /**
- * The Amazon Elastic Inference accelerator for the instance.
- */
- ElasticInferenceAcceleratorSet?: AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList;
- /**
- * Indicates whether the Amazon EC2 instance is enabled for Amazon Web Services Nitro Enclaves.
- */
- EnclaveOptions?: AwsEc2LaunchTemplateDataEnclaveOptionsDetails;
- /**
- * Specifies whether your Amazon EC2 instance is configured for hibernation.
- */
- HibernationOptions?: AwsEc2LaunchTemplateDataHibernationOptionsDetails;
- /**
- * The name or Amazon Resource Name (ARN) of an IAM instance profile.
- */
- IamInstanceProfile?: AwsEc2LaunchTemplateDataIamInstanceProfileDetails;
- /**
- * The ID of the Amazon Machine Image (AMI).
- */
- ImageId?: NonEmptyString;
- /**
- * Provides the options for specifying the instance initiated shutdown behavior.
- */
- InstanceInitiatedShutdownBehavior?: NonEmptyString;
- /**
- * Specifies the market (purchasing) option for an instance.
- */
- InstanceMarketOptions?: AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails;
- /**
- * The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes. If you specify InstanceRequirements, you can't specify InstanceType.
- */
- InstanceRequirements?: AwsEc2LaunchTemplateDataInstanceRequirementsDetails;
- /**
- * The instance type. For more information, see Instance types in the Amazon EC2 User Guide. If you specify InstanceType, you can't specify InstanceRequirements.
- */
- InstanceType?: NonEmptyString;
- /**
- * The ID of the kernel.
- */
- KernelId?: NonEmptyString;
- /**
- * The name of the key pair that allows users to connect to the instance.
- */
- KeyName?: NonEmptyString;
- /**
- * Specifies a license configuration for an instance.
- */
- LicenseSet?: AwsEc2LaunchTemplateDataLicenseSetList;
- /**
- * The maintenance options of your instance.
- */
- MaintenanceOptions?: AwsEc2LaunchTemplateDataMaintenanceOptionsDetails;
- /**
- * The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon EC2 User Guide.
- */
- MetadataOptions?: AwsEc2LaunchTemplateDataMetadataOptionsDetails;
- /**
- * The monitoring for the instance.
- */
- Monitoring?: AwsEc2LaunchTemplateDataMonitoringDetails;
- /**
- * Specifies the parameters for a network interface that is attached to the instance.
- */
- NetworkInterfaceSet?: AwsEc2LaunchTemplateDataNetworkInterfaceSetList;
- /**
- * Specifies the placement of an instance.
- */
- Placement?: AwsEc2LaunchTemplateDataPlacementDetails;
- /**
- * The options for the instance hostname.
- */
- PrivateDnsNameOptions?: AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails;
- /**
- * The ID of the RAM disk.
- */
- RamDiskId?: NonEmptyString;
- /**
- * One or more security group IDs.
- */
- SecurityGroupIdSet?: NonEmptyStringList;
- /**
- * One or more security group names. For a nondefault VPC, you must use security group IDs instead. You cannot specify both a security group ID and security name in the same request.
- */
- SecurityGroupSet?: NonEmptyStringList;
- /**
- * The user data to make available to the instance.
- */
- UserData?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails {
- /**
- * The type of Elastic Graphics accelerator.
- */
- Type?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataElasticGpuSpecificationSetList = AwsEc2LaunchTemplateDataElasticGpuSpecificationSetDetails[];
- export interface AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails {
- /**
- * The number of Elastic Inference accelerators to attach to the instance.
- */
- Count?: Integer;
- /**
- * The type of Elastic Inference accelerator.
- */
- Type?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetList = AwsEc2LaunchTemplateDataElasticInferenceAcceleratorSetDetails[];
- export interface AwsEc2LaunchTemplateDataEnclaveOptionsDetails {
- /**
- * If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves.
- */
- Enabled?: Boolean;
- }
- export interface AwsEc2LaunchTemplateDataHibernationOptionsDetails {
- /**
- * If you set this parameter to true, the instance is enabled for hibernation.
- */
- Configured?: Boolean;
- }
- export interface AwsEc2LaunchTemplateDataIamInstanceProfileDetails {
- /**
- * The Amazon Resource Name (ARN) of the instance profile.
- */
- Arn?: NonEmptyString;
- /**
- * The name of the instance profile.
- */
- Name?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataInstanceMarketOptionsDetails {
- /**
- * The market type.
- */
- MarketType?: NonEmptyString;
- /**
- * The options for Spot Instances.
- */
- SpotOptions?: AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails;
- }
- export interface AwsEc2LaunchTemplateDataInstanceMarketOptionsSpotOptionsDetails {
- /**
- * Deprecated.
- */
- BlockDurationMinutes?: Integer;
- /**
- * The behavior when a Spot Instance is interrupted.
- */
- InstanceInterruptionBehavior?: NonEmptyString;
- /**
- * The maximum hourly price you're willing to pay for the Spot Instances.
- */
- MaxPrice?: NonEmptyString;
- /**
- * The Spot Instance request type.
- */
- SpotInstanceType?: NonEmptyString;
- /**
- * The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ), for persistent requests.
- */
- ValidUntil?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails {
- /**
- * The maximum number of accelerators. If this parameter isn't specified, there's no maximum limit. To exclude accelerator-enabled instance types, set Max to 0.
- */
- Max?: Integer;
- /**
- * The minimum number of accelerators. If this parameter isn't specified, there's no minimum limit.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails {
- /**
- * The maximum amount of memory, in MiB. If this parameter isn't specified, there's no maximum limit.
- */
- Max?: Integer;
- /**
- * The minimum amount of memory, in MiB. If 0 is specified, there's no maximum limit.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails {
- /**
- * The maximum baseline bandwidth, in Mbps. If this parameter is omitted, there's no maximum limit.
- */
- Max?: Integer;
- /**
- * The minimum baseline bandwidth, in Mbps. If this parameter is omitted, there's no minimum limit.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsDetails {
- /**
- * The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
- */
- AcceleratorCount?: AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorCountDetails;
- /**
- * Indicates whether instance types must have accelerators by specific manufacturers.
- */
- AcceleratorManufacturers?: NonEmptyStringList;
- /**
- * The accelerators that must be on the instance type.
- */
- AcceleratorNames?: NonEmptyStringList;
- /**
- * The minimum and maximum amount of total accelerator memory, in MiB.
- */
- AcceleratorTotalMemoryMiB?: AwsEc2LaunchTemplateDataInstanceRequirementsAcceleratorTotalMemoryMiBDetails;
- /**
- * The accelerator types that must be on the instance type.
- */
- AcceleratorTypes?: NonEmptyStringList;
- /**
- * Indicates whether bare metal instance types must be included, excluded, or required.
- */
- BareMetal?: NonEmptyString;
- /**
- * The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS optimized instances in the Amazon EC2 User Guide.
- */
- BaselineEbsBandwidthMbps?: AwsEc2LaunchTemplateDataInstanceRequirementsBaselineEbsBandwidthMbpsDetails;
- /**
- * Indicates whether burstable performance T instance types are included, excluded, or required. For more information, Burstable performance instances in the Amazon EC2 User Guide.
- */
- BurstablePerformance?: NonEmptyString;
- /**
- * The CPU manufacturers to include.
- */
- CpuManufacturers?: NonEmptyStringList;
- /**
- * The instance types to exclude.
- */
- ExcludedInstanceTypes?: NonEmptyStringList;
- /**
- * Indicates whether current or previous generation instance types are included.
- */
- InstanceGenerations?: NonEmptyStringList;
- /**
- * Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide.
- */
- LocalStorage?: NonEmptyString;
- /**
- * The type of local storage that is required.
- */
- LocalStorageTypes?: NonEmptyStringList;
- /**
- * The minimum and maximum amount of memory per vCPU, in GiB.
- */
- MemoryGiBPerVCpu?: AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails;
- /**
- * The minimum and maximum amount of memory, in MiB.
- */
- MemoryMiB?: AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails;
- /**
- * The minimum and maximum number of network interfaces.
- */
- NetworkInterfaceCount?: AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails;
- /**
- * The price protection threshold for On-Demand Instances. This is the maximum you'll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. A high value, such as 999999, turns off price protection.
- */
- OnDemandMaxPricePercentageOverLowestPrice?: Integer;
- /**
- * Indicates whether instance types must support hibernation for On-Demand Instances.
- */
- RequireHibernateSupport?: Boolean;
- /**
- * The price protection threshold for Spot Instances. This is the maximum you'll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold. The parameter accepts an integer, which Amazon EC2 interprets as a percentage. A high value, such as 999999, turns off price protection.
- */
- SpotMaxPricePercentageOverLowestPrice?: Integer;
- /**
- * The minimum and maximum amount of total local storage, in GB.
- */
- TotalLocalStorageGB?: AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails;
- /**
- * The minimum and maximum number of vCPUs.
- */
- VCpuCount?: AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsMemoryGiBPerVCpuDetails {
- /**
- * The maximum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.
- */
- Max?: Double;
- /**
- * The minimum amount of memory per vCPU, in GiB. If this parameter is omitted, there's no maximum limit.
- */
- Min?: Double;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsMemoryMiBDetails {
- /**
- * The maximum amount of memory, in MiB.
- */
- Max?: Integer;
- /**
- * The minimum amount of memory, in MiB.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsNetworkInterfaceCountDetails {
- /**
- * The maximum number of network interfaces.
- */
- Max?: Integer;
- /**
- * The minimum number of network interfaces.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsTotalLocalStorageGBDetails {
- /**
- * The maximum amount of total local storage, in GB.
- */
- Max?: Double;
- /**
- * The minimum amount of total local storage, in GB.
- */
- Min?: Double;
- }
- export interface AwsEc2LaunchTemplateDataInstanceRequirementsVCpuCountDetails {
- /**
- * The maximum number of vCPUs.
- */
- Max?: Integer;
- /**
- * The minimum number of vCPUs.
- */
- Min?: Integer;
- }
- export interface AwsEc2LaunchTemplateDataLicenseSetDetails {
- /**
- * The Amazon Resource Name (ARN) of the license configuration.
- */
- LicenseConfigurationArn?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataLicenseSetList = AwsEc2LaunchTemplateDataLicenseSetDetails[];
- export interface AwsEc2LaunchTemplateDataMaintenanceOptionsDetails {
- /**
- * Disables the automatic recovery behavior of your instance or sets it to default.
- */
- AutoRecovery?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataMetadataOptionsDetails {
- /**
- * Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled, and you won't be able to access your instance metadata.
- */
- HttpEndpoint?: NonEmptyString;
- /**
- * Enables or disables the IPv6 endpoint for the instance metadata service.
- */
- HttpProtocolIpv6?: NonEmptyString;
- /**
- * The state of token usage for your instance metadata requests.
- */
- HttpTokens?: NonEmptyString;
- /**
- * The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
- */
- HttpPutResponseHopLimit?: Integer;
- /**
- * When set to enabled, this parameter allows access to instance tags from the instance metadata. When set to disabled, it turns off access to instance tags from the instance metadata. For more information, see Work with instance tags in instance metadata in the Amazon EC2 User Guide.
- */
- InstanceMetadataTags?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataMonitoringDetails {
- /**
- * Enables detailed monitoring when true is specified. Otherwise, basic monitoring is enabled. For more information about detailed monitoring, see Enable or turn off detailed monitoring for your instances in the Amazon EC2 User Guide.
- */
- Enabled?: Boolean;
- }
- export interface AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails {
- /**
- * Indicates whether to associate a Carrier IP address with eth0 for a new network interface. You use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information, see Carrier IP address in the Wavelength Developer Guide.
- */
- AssociateCarrierIpAddress?: Boolean;
- /**
- * Associates a public IPv4 address with eth0 for a new network interface.
- */
- AssociatePublicIpAddress?: Boolean;
- /**
- * Indicates whether the network interface is deleted when the instance is terminated.
- */
- DeleteOnTermination?: Boolean;
- /**
- * A description for the network interface.
- */
- Description?: NonEmptyString;
- /**
- * The device index for the network interface attachment.
- */
- DeviceIndex?: Integer;
- /**
- * The IDs of one or more security groups.
- */
- Groups?: NonEmptyStringList;
- /**
- * The type of network interface.
- */
- InterfaceType?: NonEmptyString;
- /**
- * The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefixes option.
- */
- Ipv4PrefixCount?: Integer;
- /**
- * One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.
- */
- Ipv4Prefixes?: AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList;
- /**
- * The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if you use Ipv6Addresses.
- */
- Ipv6AddressCount?: Integer;
- /**
- * One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you use Ipv6AddressCount.
- */
- Ipv6Addresses?: AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList;
- /**
- * The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
- */
- Ipv6PrefixCount?: Integer;
- /**
- * One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
- */
- Ipv6Prefixes?: AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList;
- /**
- * The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
- */
- NetworkCardIndex?: Integer;
- /**
- * The ID of the network interface.
- */
- NetworkInterfaceId?: NonEmptyString;
- /**
- * The primary private IPv4 address of the network interface.
- */
- PrivateIpAddress?: NonEmptyString;
- /**
- * One or more private IPv4 addresses.
- */
- PrivateIpAddresses?: AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList;
- /**
- * The number of secondary private IPv4 addresses to assign to a network interface.
- */
- SecondaryPrivateIpAddressCount?: Integer;
- /**
- * The ID of the subnet for the network interface.
- */
- SubnetId?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails {
- /**
- * The IPv4 prefix. For more information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
- */
- Ipv4Prefix?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesList = AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv4PrefixesDetails[];
- export interface AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails {
- /**
- * One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet.
- */
- Ipv6Address?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesList = AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6AddressesDetails[];
- export interface AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails {
- /**
- * The IPv6 prefix.
- */
- Ipv6Prefix?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesList = AwsEc2LaunchTemplateDataNetworkInterfaceSetIpv6PrefixesDetails[];
- export type AwsEc2LaunchTemplateDataNetworkInterfaceSetList = AwsEc2LaunchTemplateDataNetworkInterfaceSetDetails[];
- export interface AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails {
- /**
- * Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
- */
- Primary?: Boolean;
- /**
- * The private IPv4 address.
- */
- PrivateIpAddress?: NonEmptyString;
- }
- export type AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesList = AwsEc2LaunchTemplateDataNetworkInterfaceSetPrivateIpAddressesDetails[];
- export interface AwsEc2LaunchTemplateDataPlacementDetails {
- /**
- * The affinity setting for an instance on an EC2 Dedicated Host.
- */
- Affinity?: NonEmptyString;
- /**
- * The Availability Zone for the instance.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * The name of the placement group for the instance.
- */
- GroupName?: NonEmptyString;
- /**
- * The ID of the Dedicated Host for the instance.
- */
- HostId?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the host resource group in which to launch the instances.
- */
- HostResourceGroupArn?: NonEmptyString;
- /**
- * The number of the partition the instance should launch in.
- */
- PartitionNumber?: Integer;
- /**
- * Reserved for future use.
- */
- SpreadDomain?: NonEmptyString;
- /**
- * The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware.
- */
- Tenancy?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDataPrivateDnsNameOptionsDetails {
- /**
- * Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
- */
- EnableResourceNameDnsAAAARecord?: Boolean;
- /**
- * Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
- */
- EnableResourceNameDnsARecord?: Boolean;
- /**
- * The type of hostname for EC2 instances.
- */
- HostnameType?: NonEmptyString;
- }
- export interface AwsEc2LaunchTemplateDetails {
- /**
- * A name for the launch template.
- */
- LaunchTemplateName?: NonEmptyString;
- /**
- * An ID for the launch template.
- */
- Id?: NonEmptyString;
- /**
- * The information to include in the launch template.
- */
- LaunchTemplateData?: AwsEc2LaunchTemplateDataDetails;
- /**
- * The default version of the launch template.
- */
- DefaultVersionNumber?: Long;
- /**
- * The latest version of the launch template.
- */
- LatestVersionNumber?: Long;
- }
- export interface AwsEc2NetworkAclAssociation {
- /**
- * The identifier of the association between the network ACL and the subnet.
- */
- NetworkAclAssociationId?: NonEmptyString;
- /**
- * The identifier of the network ACL.
- */
- NetworkAclId?: NonEmptyString;
- /**
- * The identifier of the subnet that is associated with the network ACL.
- */
- SubnetId?: NonEmptyString;
- }
- export type AwsEc2NetworkAclAssociationList = AwsEc2NetworkAclAssociation[];
- export interface AwsEc2NetworkAclDetails {
- /**
- * Whether this is the default network ACL for the VPC.
- */
- IsDefault?: Boolean;
- /**
- * The identifier of the network ACL.
- */
- NetworkAclId?: NonEmptyString;
- /**
- * The identifier of the Amazon Web Services account that owns the network ACL.
- */
- OwnerId?: NonEmptyString;
- /**
- * The identifier of the VPC for the network ACL.
- */
- VpcId?: NonEmptyString;
- /**
- * Associations between the network ACL and subnets.
- */
- Associations?: AwsEc2NetworkAclAssociationList;
- /**
- * The set of rules in the network ACL.
- */
- Entries?: AwsEc2NetworkAclEntryList;
- }
- export interface AwsEc2NetworkAclEntry {
- /**
- * The IPV4 network range for which to deny or allow access.
- */
- CidrBlock?: NonEmptyString;
- /**
- * Whether the rule is an egress rule. An egress rule is a rule that applies to traffic that leaves the subnet.
- */
- Egress?: Boolean;
- /**
- * The Internet Control Message Protocol (ICMP) type and code for which to deny or allow access.
- */
- IcmpTypeCode?: IcmpTypeCode;
- /**
- * The IPV6 network range for which to deny or allow access.
- */
- Ipv6CidrBlock?: NonEmptyString;
- /**
- * For TCP or UDP protocols, the range of ports that the rule applies to.
- */
- PortRange?: PortRangeFromTo;
- /**
- * The protocol that the rule applies to. To deny or allow access to all protocols, use the value -1.
- */
- Protocol?: NonEmptyString;
- /**
- * Whether the rule is used to allow access or deny access.
- */
- RuleAction?: NonEmptyString;
- /**
- * The rule number. The rules are processed in order by their number.
- */
- RuleNumber?: Integer;
- }
- export type AwsEc2NetworkAclEntryList = AwsEc2NetworkAclEntry[];
- export interface AwsEc2NetworkInterfaceAttachment {
- /**
- * Indicates when the attachment initiated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- AttachTime?: NonEmptyString;
- /**
- * The identifier of the network interface attachment
- */
- AttachmentId?: NonEmptyString;
- /**
- * Indicates whether the network interface is deleted when the instance is terminated.
- */
- DeleteOnTermination?: Boolean;
- /**
- * The device index of the network interface attachment on the instance.
- */
- DeviceIndex?: Integer;
- /**
- * The ID of the instance.
- */
- InstanceId?: NonEmptyString;
- /**
- * The Amazon Web Services account ID of the owner of the instance.
- */
- InstanceOwnerId?: NonEmptyString;
- /**
- * The attachment state. Valid values: attaching | attached | detaching | detached
- */
- Status?: NonEmptyString;
- }
- export interface AwsEc2NetworkInterfaceDetails {
- /**
- * The network interface attachment.
- */
- Attachment?: AwsEc2NetworkInterfaceAttachment;
- /**
- * The ID of the network interface.
- */
- NetworkInterfaceId?: NonEmptyString;
- /**
- * Security groups for the network interface.
- */
- SecurityGroups?: AwsEc2NetworkInterfaceSecurityGroupList;
- /**
- * Indicates whether traffic to or from the instance is validated.
- */
- SourceDestCheck?: Boolean;
- /**
- * The IPv6 addresses associated with the network interface.
- */
- IpV6Addresses?: AwsEc2NetworkInterfaceIpV6AddressList;
- /**
- * The private IPv4 addresses associated with the network interface.
- */
- PrivateIpAddresses?: AwsEc2NetworkInterfacePrivateIpAddressList;
- /**
- * The public DNS name of the network interface.
- */
- PublicDnsName?: NonEmptyString;
- /**
- * The address of the Elastic IP address bound to the network interface.
- */
- PublicIp?: NonEmptyString;
- }
- export interface AwsEc2NetworkInterfaceIpV6AddressDetail {
- /**
- * The IPV6 address.
- */
- IpV6Address?: NonEmptyString;
- }
- export type AwsEc2NetworkInterfaceIpV6AddressList = AwsEc2NetworkInterfaceIpV6AddressDetail[];
- export interface AwsEc2NetworkInterfacePrivateIpAddressDetail {
- /**
- * The IP address.
- */
- PrivateIpAddress?: NonEmptyString;
- /**
- * The private DNS name for the IP address.
- */
- PrivateDnsName?: NonEmptyString;
- }
- export type AwsEc2NetworkInterfacePrivateIpAddressList = AwsEc2NetworkInterfacePrivateIpAddressDetail[];
- export interface AwsEc2NetworkInterfaceSecurityGroup {
- /**
- * The name of the security group.
- */
- GroupName?: NonEmptyString;
- /**
- * The ID of the security group.
- */
- GroupId?: NonEmptyString;
- }
- export type AwsEc2NetworkInterfaceSecurityGroupList = AwsEc2NetworkInterfaceSecurityGroup[];
- export interface AwsEc2RouteTableDetails {
- /**
- * The associations between a route table and one or more subnets or a gateway.
- */
- AssociationSet?: AssociationSetList;
- /**
- * The ID of the Amazon Web Services account that owns the route table.
- */
- OwnerId?: NonEmptyString;
- /**
- * Describes a virtual private gateway propagating route.
- */
- PropagatingVgwSet?: PropagatingVgwSetList;
- /**
- * The ID of the route table.
- */
- RouteTableId?: NonEmptyString;
- /**
- * The routes in the route table.
- */
- RouteSet?: RouteSetList;
- /**
- * The ID of the virtual private cloud (VPC).
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsEc2SecurityGroupDetails {
- /**
- * The name of the security group.
- */
- GroupName?: NonEmptyString;
- /**
- * The ID of the security group.
- */
- GroupId?: NonEmptyString;
- /**
- * The Amazon Web Services account ID of the owner of the security group.
- */
- OwnerId?: NonEmptyString;
- /**
- * [VPC only] The ID of the VPC for the security group.
- */
- VpcId?: NonEmptyString;
- /**
- * The inbound rules associated with the security group.
- */
- IpPermissions?: AwsEc2SecurityGroupIpPermissionList;
- /**
- * [VPC only] The outbound rules associated with the security group.
- */
- IpPermissionsEgress?: AwsEc2SecurityGroupIpPermissionList;
- }
- export interface AwsEc2SecurityGroupIpPermission {
- /**
- * The IP protocol name (tcp, udp, icmp, icmpv6) or number. [VPC only] Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional. If you omit the port range, traffic for all types and codes is allowed.
- */
- IpProtocol?: NonEmptyString;
- /**
- * The start of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- */
- FromPort?: Integer;
- /**
- * The end of the port range for the TCP and UDP protocols, or an ICMP/ICMPv6 code. A value of -1 indicates all ICMP/ICMPv6 codes. If you specify all ICMP/ICMPv6 types, you must specify all codes.
- */
- ToPort?: Integer;
- /**
- * The security group and Amazon Web Services account ID pairs.
- */
- UserIdGroupPairs?: AwsEc2SecurityGroupUserIdGroupPairList;
- /**
- * The IPv4 ranges.
- */
- IpRanges?: AwsEc2SecurityGroupIpRangeList;
- /**
- * The IPv6 ranges.
- */
- Ipv6Ranges?: AwsEc2SecurityGroupIpv6RangeList;
- /**
- * [VPC only] The prefix list IDs for an Amazon Web Services service. With outbound rules, this is the Amazon Web Services service to access through a VPC endpoint from instances associated with the security group.
- */
- PrefixListIds?: AwsEc2SecurityGroupPrefixListIdList;
- }
- export type AwsEc2SecurityGroupIpPermissionList = AwsEc2SecurityGroupIpPermission[];
- export interface AwsEc2SecurityGroupIpRange {
- /**
- * The IPv4 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv4 address, use the /32 prefix length.
- */
- CidrIp?: NonEmptyString;
- }
- export type AwsEc2SecurityGroupIpRangeList = AwsEc2SecurityGroupIpRange[];
- export interface AwsEc2SecurityGroupIpv6Range {
- /**
- * The IPv6 CIDR range. You can specify either a CIDR range or a source security group, but not both. To specify a single IPv6 address, use the /128 prefix length.
- */
- CidrIpv6?: NonEmptyString;
- }
- export type AwsEc2SecurityGroupIpv6RangeList = AwsEc2SecurityGroupIpv6Range[];
- export interface AwsEc2SecurityGroupPrefixListId {
- /**
- * The ID of the prefix.
- */
- PrefixListId?: NonEmptyString;
- }
- export type AwsEc2SecurityGroupPrefixListIdList = AwsEc2SecurityGroupPrefixListId[];
- export interface AwsEc2SecurityGroupUserIdGroupPair {
- /**
- * The ID of the security group.
- */
- GroupId?: NonEmptyString;
- /**
- * The name of the security group.
- */
- GroupName?: NonEmptyString;
- /**
- * The status of a VPC peering connection, if applicable.
- */
- PeeringStatus?: NonEmptyString;
- /**
- * The ID of an Amazon Web Services account. For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned. [EC2-Classic] Required when adding or removing rules that reference a security group in another VPC.
- */
- UserId?: NonEmptyString;
- /**
- * The ID of the VPC for the referenced security group, if applicable.
- */
- VpcId?: NonEmptyString;
- /**
- * The ID of the VPC peering connection, if applicable.
- */
- VpcPeeringConnectionId?: NonEmptyString;
- }
- export type AwsEc2SecurityGroupUserIdGroupPairList = AwsEc2SecurityGroupUserIdGroupPair[];
- export interface AwsEc2SubnetDetails {
- /**
- * Whether to assign an IPV6 address to a network interface that is created in this subnet.
- */
- AssignIpv6AddressOnCreation?: Boolean;
- /**
- * The Availability Zone for the subnet.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * The identifier of the Availability Zone for the subnet.
- */
- AvailabilityZoneId?: NonEmptyString;
- /**
- * The number of available IPV4 addresses in the subnet. Does not include addresses for stopped instances.
- */
- AvailableIpAddressCount?: Integer;
- /**
- * The IPV4 CIDR block that is assigned to the subnet.
- */
- CidrBlock?: NonEmptyString;
- /**
- * Whether this subnet is the default subnet for the Availability Zone.
- */
- DefaultForAz?: Boolean;
- /**
- * Whether instances in this subnet receive a public IP address.
- */
- MapPublicIpOnLaunch?: Boolean;
- /**
- * The identifier of the Amazon Web Services account that owns the subnet.
- */
- OwnerId?: NonEmptyString;
- /**
- * The current state of the subnet. Valid values are available or pending.
- */
- State?: NonEmptyString;
- /**
- * The ARN of the subnet.
- */
- SubnetArn?: NonEmptyString;
- /**
- * The identifier of the subnet.
- */
- SubnetId?: NonEmptyString;
- /**
- * The identifier of the VPC that contains the subnet.
- */
- VpcId?: NonEmptyString;
- /**
- * The IPV6 CIDR blocks that are associated with the subnet.
- */
- Ipv6CidrBlockAssociationSet?: Ipv6CidrBlockAssociationList;
- }
- export interface AwsEc2TransitGatewayDetails {
- /**
- * The ID of the transit gateway.
- */
- Id?: NonEmptyString;
- /**
- * The description of the transit gateway.
- */
- Description?: NonEmptyString;
- /**
- * Turn on or turn off automatic propagation of routes to the default propagation route table.
- */
- DefaultRouteTablePropagation?: NonEmptyString;
- /**
- * Turn on or turn off automatic acceptance of attachment requests.
- */
- AutoAcceptSharedAttachments?: NonEmptyString;
- /**
- * Turn on or turn off automatic association with the default association route table.
- */
- DefaultRouteTableAssociation?: NonEmptyString;
- /**
- * The transit gateway Classless Inter-Domain Routing (CIDR) blocks.
- */
- TransitGatewayCidrBlocks?: NonEmptyStringList;
- /**
- * The ID of the default association route table.
- */
- AssociationDefaultRouteTableId?: NonEmptyString;
- /**
- * The ID of the default propagation route table.
- */
- PropagationDefaultRouteTableId?: NonEmptyString;
- /**
- * Turn on or turn off Equal Cost Multipath Protocol (ECMP) support.
- */
- VpnEcmpSupport?: NonEmptyString;
- /**
- * Turn on or turn off DNS support.
- */
- DnsSupport?: NonEmptyString;
- /**
- * Indicates whether multicast is supported on the transit gateway.
- */
- MulticastSupport?: NonEmptyString;
- /**
- * A private Autonomous System Number (ASN) for the Amazon side of a BGP session.
- */
- AmazonSideAsn?: Integer;
- }
- export interface AwsEc2VolumeAttachment {
- /**
- * The datetime when the attachment initiated.
- */
- AttachTime?: NonEmptyString;
- /**
- * Whether the EBS volume is deleted when the EC2 instance is terminated.
- */
- DeleteOnTermination?: Boolean;
- /**
- * The identifier of the EC2 instance.
- */
- InstanceId?: NonEmptyString;
- /**
- * The attachment state of the volume. Valid values are as follows: attaching attached busy detaching detached
- */
- Status?: NonEmptyString;
- }
- export type AwsEc2VolumeAttachmentList = AwsEc2VolumeAttachment[];
- export interface AwsEc2VolumeDetails {
- /**
- * Indicates when the volume was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateTime?: NonEmptyString;
- /**
- * The device name for the volume that is attached to the instance.
- */
- DeviceName?: NonEmptyString;
- /**
- * Specifies whether the volume is encrypted.
- */
- Encrypted?: Boolean;
- /**
- * The size of the volume, in GiBs.
- */
- Size?: Integer;
- /**
- * The snapshot from which the volume was created.
- */
- SnapshotId?: NonEmptyString;
- /**
- * The volume state. Valid values are as follows: available creating deleted deleting error in-use
- */
- Status?: NonEmptyString;
- /**
- * The ARN of the KMS key that was used to protect the volume encryption key for the volume.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The volume attachments.
- */
- Attachments?: AwsEc2VolumeAttachmentList;
- /**
- * The ID of the volume.
- */
- VolumeId?: NonEmptyString;
- /**
- * The volume type.
- */
- VolumeType?: NonEmptyString;
- /**
- * Indicates whether the volume was scanned or skipped.
- */
- VolumeScanStatus?: NonEmptyString;
- }
- export interface AwsEc2VpcDetails {
- /**
- * Information about the IPv4 CIDR blocks associated with the VPC.
- */
- CidrBlockAssociationSet?: CidrBlockAssociationList;
- /**
- * Information about the IPv6 CIDR blocks associated with the VPC.
- */
- Ipv6CidrBlockAssociationSet?: Ipv6CidrBlockAssociationList;
- /**
- * The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.
- */
- DhcpOptionsId?: NonEmptyString;
- /**
- * The current state of the VPC. Valid values are available or pending.
- */
- State?: NonEmptyString;
- }
- export interface AwsEc2VpcEndpointServiceDetails {
- /**
- * Whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
- */
- AcceptanceRequired?: Boolean;
- /**
- * The Availability Zones where the service is available.
- */
- AvailabilityZones?: NonEmptyStringList;
- /**
- * The DNS names for the service.
- */
- BaseEndpointDnsNames?: NonEmptyStringList;
- /**
- * Whether the service manages its VPC endpoints.
- */
- ManagesVpcEndpoints?: Boolean;
- /**
- * The ARNs of the Gateway Load Balancers for the service.
- */
- GatewayLoadBalancerArns?: NonEmptyStringList;
- /**
- * The ARNs of the Network Load Balancers for the service.
- */
- NetworkLoadBalancerArns?: NonEmptyStringList;
- /**
- * The private DNS name for the service.
- */
- PrivateDnsName?: NonEmptyString;
- /**
- * The identifier of the service.
- */
- ServiceId?: NonEmptyString;
- /**
- * The name of the service.
- */
- ServiceName?: NonEmptyString;
- /**
- * The current state of the service. Valid values are as follows: Available Deleted Deleting Failed Pending
- */
- ServiceState?: NonEmptyString;
- /**
- * The types for the service.
- */
- ServiceType?: AwsEc2VpcEndpointServiceServiceTypeList;
- }
- export interface AwsEc2VpcEndpointServiceServiceTypeDetails {
- /**
- * The type of service.
- */
- ServiceType?: NonEmptyString;
- }
- export type AwsEc2VpcEndpointServiceServiceTypeList = AwsEc2VpcEndpointServiceServiceTypeDetails[];
- export interface AwsEc2VpcPeeringConnectionDetails {
- /**
- * Information about the accepter VPC.
- */
- AccepterVpcInfo?: AwsEc2VpcPeeringConnectionVpcInfoDetails;
- /**
- * The time at which an unaccepted VPC peering connection will expire.
- */
- ExpirationTime?: NonEmptyString;
- /**
- * Information about the requester VPC.
- */
- RequesterVpcInfo?: AwsEc2VpcPeeringConnectionVpcInfoDetails;
- /**
- * The status of the VPC peering connection.
- */
- Status?: AwsEc2VpcPeeringConnectionStatusDetails;
- /**
- * The ID of the VPC peering connection.
- */
- VpcPeeringConnectionId?: NonEmptyString;
- }
- export interface AwsEc2VpcPeeringConnectionStatusDetails {
- /**
- * The status of the VPC peering connection.
- */
- Code?: NonEmptyString;
- /**
- * A message that provides more information about the status, if applicable.
- */
- Message?: NonEmptyString;
- }
- export interface AwsEc2VpcPeeringConnectionVpcInfoDetails {
- /**
- * The IPv4 CIDR block for the VPC.
- */
- CidrBlock?: NonEmptyString;
- /**
- * Information about the IPv4 CIDR blocks for the VPC.
- */
- CidrBlockSet?: VpcInfoCidrBlockSetList;
- /**
- * The IPv6 CIDR block for the VPC.
- */
- Ipv6CidrBlockSet?: VpcInfoIpv6CidrBlockSetList;
- /**
- * The ID of the Amazon Web Services account that owns the VPC.
- */
- OwnerId?: NonEmptyString;
- /**
- * Information about the VPC peering connection options for the accepter or requester VPC.
- */
- PeeringOptions?: VpcInfoPeeringOptionsDetails;
- /**
- * The Amazon Web Services Region in which the VPC is located.
- */
- Region?: NonEmptyString;
- /**
- * The ID of the VPC.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsEc2VpnConnectionDetails {
- /**
- * The identifier of the VPN connection.
- */
- VpnConnectionId?: NonEmptyString;
- /**
- * The current state of the VPN connection. Valid values are as follows: available deleted deleting pending
- */
- State?: NonEmptyString;
- /**
- * The identifier of the customer gateway that is at your end of the VPN connection.
- */
- CustomerGatewayId?: NonEmptyString;
- /**
- * The configuration information for the VPN connection's customer gateway, in the native XML format.
- */
- CustomerGatewayConfiguration?: NonEmptyString;
- /**
- * The type of VPN connection.
- */
- Type?: NonEmptyString;
- /**
- * The identifier of the virtual private gateway that is at the Amazon Web Services side of the VPN connection.
- */
- VpnGatewayId?: NonEmptyString;
- /**
- * The category of the VPN connection. VPN indicates an Amazon Web Services VPN connection. VPN-Classic indicates an Amazon Web Services Classic VPN connection.
- */
- Category?: NonEmptyString;
- /**
- * Information about the VPN tunnel.
- */
- VgwTelemetry?: AwsEc2VpnConnectionVgwTelemetryList;
- /**
- * The VPN connection options.
- */
- Options?: AwsEc2VpnConnectionOptionsDetails;
- /**
- * The static routes that are associated with the VPN connection.
- */
- Routes?: AwsEc2VpnConnectionRoutesList;
- /**
- * The identifier of the transit gateway that is associated with the VPN connection.
- */
- TransitGatewayId?: NonEmptyString;
- }
- export interface AwsEc2VpnConnectionOptionsDetails {
- /**
- * Whether the VPN connection uses static routes only.
- */
- StaticRoutesOnly?: Boolean;
- /**
- * The VPN tunnel options.
- */
- TunnelOptions?: AwsEc2VpnConnectionOptionsTunnelOptionsList;
- }
- export interface AwsEc2VpnConnectionOptionsTunnelOptionsDetails {
- /**
- * The number of seconds after which a Dead Peer Detection (DPD) timeout occurs.
- */
- DpdTimeoutSeconds?: Integer;
- /**
- * The Internet Key Exchange (IKE) versions that are permitted for the VPN tunnel.
- */
- IkeVersions?: NonEmptyStringList;
- /**
- * The external IP address of the VPN tunnel.
- */
- OutsideIpAddress?: NonEmptyString;
- /**
- * The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
- */
- Phase1DhGroupNumbers?: IntegerList;
- /**
- * The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
- */
- Phase1EncryptionAlgorithms?: NonEmptyStringList;
- /**
- * The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
- */
- Phase1IntegrityAlgorithms?: NonEmptyStringList;
- /**
- * The lifetime for phase 1 of the IKE negotiation, in seconds.
- */
- Phase1LifetimeSeconds?: Integer;
- /**
- * The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
- */
- Phase2DhGroupNumbers?: IntegerList;
- /**
- * The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
- */
- Phase2EncryptionAlgorithms?: NonEmptyStringList;
- /**
- * The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
- */
- Phase2IntegrityAlgorithms?: NonEmptyStringList;
- /**
- * The lifetime for phase 2 of the IKE negotiation, in seconds.
- */
- Phase2LifetimeSeconds?: Integer;
- /**
- * The preshared key to establish initial authentication between the virtual private gateway and the customer gateway.
- */
- PreSharedKey?: NonEmptyString;
- /**
- * The percentage of the rekey window, which is determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
- */
- RekeyFuzzPercentage?: Integer;
- /**
- * The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.
- */
- RekeyMarginTimeSeconds?: Integer;
- /**
- * The number of packets in an IKE replay window.
- */
- ReplayWindowSize?: Integer;
- /**
- * The range of inside IPv4 addresses for the tunnel.
- */
- TunnelInsideCidr?: NonEmptyString;
- }
- export type AwsEc2VpnConnectionOptionsTunnelOptionsList = AwsEc2VpnConnectionOptionsTunnelOptionsDetails[];
- export interface AwsEc2VpnConnectionRoutesDetails {
- /**
- * The CIDR block associated with the local subnet of the customer data center.
- */
- DestinationCidrBlock?: NonEmptyString;
- /**
- * The current state of the static route.
- */
- State?: NonEmptyString;
- }
- export type AwsEc2VpnConnectionRoutesList = AwsEc2VpnConnectionRoutesDetails[];
- export interface AwsEc2VpnConnectionVgwTelemetryDetails {
- /**
- * The number of accepted routes.
- */
- AcceptedRouteCount?: Integer;
- /**
- * The ARN of the VPN tunnel endpoint certificate.
- */
- CertificateArn?: NonEmptyString;
- /**
- * The date and time of the last change in status. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastStatusChange?: NonEmptyString;
- /**
- * The Internet-routable IP address of the virtual private gateway's outside interface.
- */
- OutsideIpAddress?: NonEmptyString;
- /**
- * The status of the VPN tunnel. Valid values are DOWN or UP.
- */
- Status?: NonEmptyString;
- /**
- * If an error occurs, a description of the error.
- */
- StatusMessage?: NonEmptyString;
- }
- export type AwsEc2VpnConnectionVgwTelemetryList = AwsEc2VpnConnectionVgwTelemetryDetails[];
- export interface AwsEcrContainerImageDetails {
- /**
- * The Amazon Web Services account identifier that is associated with the registry that the image belongs to.
- */
- RegistryId?: NonEmptyString;
- /**
- * The name of the repository that the image belongs to.
- */
- RepositoryName?: NonEmptyString;
- /**
- * The architecture of the image. Valid values are as follows: arm64 i386 x86_64
- */
- Architecture?: NonEmptyString;
- /**
- * The sha256 digest of the image manifest.
- */
- ImageDigest?: NonEmptyString;
- /**
- * The list of tags that are associated with the image.
- */
- ImageTags?: NonEmptyStringList;
- /**
- * The date and time when the image was pushed to the repository. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ImagePublishedAt?: NonEmptyString;
- }
- export interface AwsEcrRepositoryDetails {
- /**
- * The ARN of the repository.
- */
- Arn?: NonEmptyString;
- /**
- * The image scanning configuration for a repository.
- */
- ImageScanningConfiguration?: AwsEcrRepositoryImageScanningConfigurationDetails;
- /**
- * The tag mutability setting for the repository. Valid values are IMMUTABLE or MUTABLE.
- */
- ImageTagMutability?: NonEmptyString;
- /**
- * Information about the lifecycle policy for the repository.
- */
- LifecyclePolicy?: AwsEcrRepositoryLifecyclePolicyDetails;
- /**
- * The name of the repository.
- */
- RepositoryName?: NonEmptyString;
- /**
- * The text of the repository policy.
- */
- RepositoryPolicyText?: NonEmptyString;
- }
- export interface AwsEcrRepositoryImageScanningConfigurationDetails {
- /**
- * Whether to scan images after they are pushed to a repository.
- */
- ScanOnPush?: Boolean;
- }
- export interface AwsEcrRepositoryLifecyclePolicyDetails {
- /**
- * The text of the lifecycle policy.
- */
- LifecyclePolicyText?: NonEmptyString;
- /**
- * The Amazon Web Services account identifier that is associated with the registry that contains the repository.
- */
- RegistryId?: NonEmptyString;
- }
- export interface AwsEcsClusterClusterSettingsDetails {
- /**
- * The name of the setting. The valid value is containerInsights.
- */
- Name?: NonEmptyString;
- /**
- * The value of the setting. Valid values are disabled or enabled.
- */
- Value?: NonEmptyString;
- }
- export type AwsEcsClusterClusterSettingsList = AwsEcsClusterClusterSettingsDetails[];
- export interface AwsEcsClusterConfigurationDetails {
- /**
- * Contains the run command configuration for the cluster.
- */
- ExecuteCommandConfiguration?: AwsEcsClusterConfigurationExecuteCommandConfigurationDetails;
- }
- export interface AwsEcsClusterConfigurationExecuteCommandConfigurationDetails {
- /**
- * The identifier of the KMS key that is used to encrypt the data between the local client and the container.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The log configuration for the results of the run command actions. Required if Logging is NONE.
- */
- LogConfiguration?: AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails;
- /**
- * The log setting to use for redirecting logs for run command results.
- */
- Logging?: NonEmptyString;
- }
- export interface AwsEcsClusterConfigurationExecuteCommandConfigurationLogConfigurationDetails {
- /**
- * Whether to enable encryption on the CloudWatch logs.
- */
- CloudWatchEncryptionEnabled?: Boolean;
- /**
- * The name of the CloudWatch log group to send the logs to.
- */
- CloudWatchLogGroupName?: NonEmptyString;
- /**
- * The name of the S3 bucket to send logs to.
- */
- S3BucketName?: NonEmptyString;
- /**
- * Whether to encrypt the logs that are sent to the S3 bucket.
- */
- S3EncryptionEnabled?: Boolean;
- /**
- * Identifies the folder in the S3 bucket to send the logs to.
- */
- S3KeyPrefix?: NonEmptyString;
- }
- export interface AwsEcsClusterDefaultCapacityProviderStrategyDetails {
- /**
- * The minimum number of tasks to run on the specified capacity provider.
- */
- Base?: Integer;
- /**
- * The name of the capacity provider.
- */
- CapacityProvider?: NonEmptyString;
- /**
- * The relative percentage of the total number of tasks launched that should use the capacity provider.
- */
- Weight?: Integer;
- }
- export type AwsEcsClusterDefaultCapacityProviderStrategyList = AwsEcsClusterDefaultCapacityProviderStrategyDetails[];
- export interface AwsEcsClusterDetails {
- /**
- * The Amazon Resource Name (ARN) that identifies the cluster.
- */
- ClusterArn?: NonEmptyString;
- /**
- * The number of services that are running on the cluster in an ACTIVE state. You can view these services with the Amazon ECS ListServices API operation.
- */
- ActiveServicesCount?: Integer;
- /**
- * The short name of one or more capacity providers to associate with the cluster.
- */
- CapacityProviders?: NonEmptyStringList;
- /**
- * The setting to use to create the cluster. Specifically used to configure whether to enable CloudWatch Container Insights for the cluster.
- */
- ClusterSettings?: AwsEcsClusterClusterSettingsList;
- /**
- * The run command configuration for the cluster.
- */
- Configuration?: AwsEcsClusterConfigurationDetails;
- /**
- * The default capacity provider strategy for the cluster. The default capacity provider strategy is used when services or tasks are run without a specified launch type or capacity provider strategy.
- */
- DefaultCapacityProviderStrategy?: AwsEcsClusterDefaultCapacityProviderStrategyList;
- /**
- * A name that you use to identify your cluster.
- */
- ClusterName?: NonEmptyString;
- /**
- * The number of container instances registered into the cluster. This includes container instances in both ACTIVE and DRAINING status.
- */
- RegisteredContainerInstancesCount?: Integer;
- /**
- * The number of tasks in the cluster that are in the RUNNING state.
- */
- RunningTasksCount?: Integer;
- /**
- * The status of the cluster.
- */
- Status?: NonEmptyString;
- }
- export interface AwsEcsContainerDetails {
- /**
- * The name of the container.
- */
- Name?: NonEmptyString;
- /**
- * The image used for the container.
- */
- Image?: NonEmptyString;
- /**
- * The mount points for data volumes in your container.
- */
- MountPoints?: AwsMountPointList;
- /**
- * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
- */
- Privileged?: Boolean;
- }
- export type AwsEcsContainerDetailsList = AwsEcsContainerDetails[];
- export interface AwsEcsServiceCapacityProviderStrategyDetails {
- /**
- * The minimum number of tasks to run on the capacity provider. Only one strategy item can specify a value for Base. The value must be between 0 and 100000.
- */
- Base?: Integer;
- /**
- * The short name of the capacity provider.
- */
- CapacityProvider?: NonEmptyString;
- /**
- * The relative percentage of the total number of tasks that should use the capacity provider. If no weight is specified, the default value is 0. At least one capacity provider must have a weight greater than 0. The value can be between 0 and 1000.
- */
- Weight?: Integer;
- }
- export type AwsEcsServiceCapacityProviderStrategyList = AwsEcsServiceCapacityProviderStrategyDetails[];
- export interface AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails {
- /**
- * Whether to enable the deployment circuit breaker logic for the service.
- */
- Enable?: Boolean;
- /**
- * Whether to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.
- */
- Rollback?: Boolean;
- }
- export interface AwsEcsServiceDeploymentConfigurationDetails {
- /**
- * Determines whether a service deployment fails if a service cannot reach a steady state.
- */
- DeploymentCircuitBreaker?: AwsEcsServiceDeploymentConfigurationDeploymentCircuitBreakerDetails;
- /**
- * For a service that uses the rolling update (ECS) deployment type, the maximum number of tasks in a service that are allowed in the RUNNING or PENDING state during a deployment, and for tasks that use the EC2 launch type, when any container instances are in the DRAINING state. Provided as a percentage of the desired number of tasks. The default value is 200%. For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types, and tasks that use the EC2 launch type, the maximum number of tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. For the Fargate launch type, the maximum percent value is not used.
- */
- MaximumPercent?: Integer;
- /**
- * For a service that uses the rolling update (ECS) deployment type, the minimum number of tasks in a service that must remain in the RUNNING state during a deployment, and while any container instances are in the DRAINING state if the service contains tasks using the EC2 launch type. Expressed as a percentage of the desired number of tasks. The default value is 100%. For a service that uses the blue/green (CODE_DEPLOY) or EXTERNAL deployment types and tasks that use the EC2 launch type, the minimum number of the tasks in the service that remain in the RUNNING state while the container instances are in the DRAINING state. For the Fargate launch type, the minimum healthy percent value is not used.
- */
- MinimumHealthyPercent?: Integer;
- }
- export interface AwsEcsServiceDeploymentControllerDetails {
- /**
- * The rolling update (ECS) deployment type replaces the current running version of the container with the latest version. The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model that is powered by CodeDeploy. This deployment model a new deployment of a service can be verified before production traffic is sent to it. The external (EXTERNAL) deployment type allows the use of any third-party deployment controller for full control over the deployment process for an Amazon ECS service. Valid values: ECS | CODE_DEPLOY | EXTERNAL
- */
- Type?: NonEmptyString;
- }
- export interface AwsEcsServiceDetails {
- /**
- * The capacity provider strategy that the service uses.
- */
- CapacityProviderStrategy?: AwsEcsServiceCapacityProviderStrategyList;
- /**
- * The ARN of the cluster that hosts the service.
- */
- Cluster?: NonEmptyString;
- /**
- * Deployment parameters for the service. Includes the number of tasks that run and the order in which to start and stop tasks.
- */
- DeploymentConfiguration?: AwsEcsServiceDeploymentConfigurationDetails;
- /**
- * Contains the deployment controller type that the service uses.
- */
- DeploymentController?: AwsEcsServiceDeploymentControllerDetails;
- /**
- * The number of instantiations of the task definition to run on the service.
- */
- DesiredCount?: Integer;
- /**
- * Whether to enable Amazon ECS managed tags for the tasks in the service.
- */
- EnableEcsManagedTags?: Boolean;
- /**
- * Whether the execute command functionality is enabled for the service.
- */
- EnableExecuteCommand?: Boolean;
- /**
- * After a task starts, the amount of time in seconds that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks.
- */
- HealthCheckGracePeriodSeconds?: Integer;
- /**
- * The launch type that the service uses. Valid values: EC2 | FARGATE | EXTERNAL
- */
- LaunchType?: NonEmptyString;
- /**
- * Information about the load balancers that the service uses.
- */
- LoadBalancers?: AwsEcsServiceLoadBalancersList;
- /**
- * The name of the service.
- */
- Name?: NonEmptyString;
- /**
- * For tasks that use the awsvpc networking mode, the VPC subnet and security group configuration.
- */
- NetworkConfiguration?: AwsEcsServiceNetworkConfigurationDetails;
- /**
- * The placement constraints for the tasks in the service.
- */
- PlacementConstraints?: AwsEcsServicePlacementConstraintsList;
- /**
- * Information about how tasks for the service are placed.
- */
- PlacementStrategies?: AwsEcsServicePlacementStrategiesList;
- /**
- * The platform version on which to run the service. Only specified for tasks that are hosted on Fargate. If a platform version is not specified, the LATEST platform version is used by default.
- */
- PlatformVersion?: NonEmptyString;
- /**
- * Indicates whether to propagate the tags from the task definition to the task or from the service to the task. If no value is provided, then tags are not propagated. Valid values: TASK_DEFINITION | SERVICE
- */
- PropagateTags?: NonEmptyString;
- /**
- * The ARN of the IAM role that is associated with the service. The role allows the Amazon ECS container agent to register container instances with an Elastic Load Balancing load balancer.
- */
- Role?: NonEmptyString;
- /**
- * The scheduling strategy to use for the service. The REPLICA scheduling strategy places and maintains the desired number of tasks across the cluster. By default, the service scheduler spreads tasks across Availability Zones. Task placement strategies and constraints are used to customize task placement decisions. The DAEMON scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that are specified in the cluster. The service scheduler also evaluates the task placement constraints for running tasks and stops tasks that do not meet the placement constraints. Valid values: REPLICA | DAEMON
- */
- SchedulingStrategy?: NonEmptyString;
- /**
- * The ARN of the service.
- */
- ServiceArn?: NonEmptyString;
- /**
- * The name of the service. The name can contain up to 255 characters. It can use letters, numbers, underscores, and hyphens.
- */
- ServiceName?: NonEmptyString;
- /**
- * Information about the service discovery registries to assign to the service.
- */
- ServiceRegistries?: AwsEcsServiceServiceRegistriesList;
- /**
- * The task definition to use for tasks in the service.
- */
- TaskDefinition?: NonEmptyString;
- }
- export interface AwsEcsServiceLoadBalancersDetails {
- /**
- * The name of the container to associate with the load balancer.
- */
- ContainerName?: NonEmptyString;
- /**
- * The port on the container to associate with the load balancer. This port must correspond to a containerPort in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they are launched on must allow ingress traffic on the hostPort of the port mapping.
- */
- ContainerPort?: Integer;
- /**
- * The name of the load balancer to associate with the Amazon ECS service or task set. Only specified when using a Classic Load Balancer. For an Application Load Balancer or a Network Load Balancer, the load balancer name is omitted.
- */
- LoadBalancerName?: NonEmptyString;
- /**
- * The ARN of the Elastic Load Balancing target group or groups associated with a service or task set. Only specified when using an Application Load Balancer or a Network Load Balancer. For a Classic Load Balancer, the target group ARN is omitted.
- */
- TargetGroupArn?: NonEmptyString;
- }
- export type AwsEcsServiceLoadBalancersList = AwsEcsServiceLoadBalancersDetails[];
- export interface AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails {
- /**
- * Whether the task's elastic network interface receives a public IP address. The default value is DISABLED. Valid values: ENABLED | DISABLED
- */
- AssignPublicIp?: NonEmptyString;
- /**
- * The IDs of the security groups associated with the task or service. You can provide up to five security groups.
- */
- SecurityGroups?: NonEmptyStringList;
- /**
- * The IDs of the subnets associated with the task or service. You can provide up to 16 subnets.
- */
- Subnets?: NonEmptyStringList;
- }
- export interface AwsEcsServiceNetworkConfigurationDetails {
- /**
- * The VPC subnet and security group configuration.
- */
- AwsVpcConfiguration?: AwsEcsServiceNetworkConfigurationAwsVpcConfigurationDetails;
- }
- export interface AwsEcsServicePlacementConstraintsDetails {
- /**
- * A cluster query language expression to apply to the constraint. You cannot specify an expression if the constraint type is distinctInstance.
- */
- Expression?: NonEmptyString;
- /**
- * The type of constraint. Use distinctInstance to run each task in a particular group on a different container instance. Use memberOf to restrict the selection to a group of valid candidates. Valid values: distinctInstance | memberOf
- */
- Type?: NonEmptyString;
- }
- export type AwsEcsServicePlacementConstraintsList = AwsEcsServicePlacementConstraintsDetails[];
- export interface AwsEcsServicePlacementStrategiesDetails {
- /**
- * The field to apply the placement strategy against. For the spread placement strategy, valid values are instanceId (or host, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as attribute:ecs.availability-zone. For the binpack placement strategy, valid values are cpu and memory. For the random placement strategy, this attribute is not used.
- */
- Field?: NonEmptyString;
- /**
- * The type of placement strategy. The random placement strategy randomly places tasks on available candidates. The spread placement strategy spreads placement across available candidates evenly based on the value of Field. The binpack strategy places tasks on available candidates that have the least available amount of the resource that is specified in Field. Valid values: random | spread | binpack
- */
- Type?: NonEmptyString;
- }
- export type AwsEcsServicePlacementStrategiesList = AwsEcsServicePlacementStrategiesDetails[];
- export interface AwsEcsServiceServiceRegistriesDetails {
- /**
- * The container name value to use for the service discovery service. If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort. If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.
- */
- ContainerName?: NonEmptyString;
- /**
- * The port value to use for the service discovery service. If the task definition uses the bridge or host network mode, you must specify ContainerName and ContainerPort. If the task definition uses the awsvpc network mode and a type SRV DNS record, you must specify either ContainerName and ContainerPort, or Port , but not both.
- */
- ContainerPort?: Integer;
- /**
- * The port value to use for a service discovery service that specifies an SRV record. This field can be used if both the awsvpcawsvpc network mode and SRV records are used.
- */
- Port?: Integer;
- /**
- * The ARN of the service registry.
- */
- RegistryArn?: NonEmptyString;
- }
- export type AwsEcsServiceServiceRegistriesList = AwsEcsServiceServiceRegistriesDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails {
- /**
- * The dependency condition of the dependent container. Indicates the required status of the dependent container before the current container can start. Valid values are as follows: COMPLETE HEALTHY SUCCESS START
- */
- Condition?: NonEmptyString;
- /**
- * The name of the dependent container.
- */
- ContainerName?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsDependsOnList = AwsEcsTaskDefinitionContainerDefinitionsDependsOnDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsDetails {
- /**
- * The command that is passed to the container.
- */
- Command?: NonEmptyStringList;
- /**
- * The number of CPU units reserved for the container.
- */
- Cpu?: Integer;
- /**
- * The dependencies that are defined for container startup and shutdown.
- */
- DependsOn?: AwsEcsTaskDefinitionContainerDefinitionsDependsOnList;
- /**
- * Whether to disable networking within the container.
- */
- DisableNetworking?: Boolean;
- /**
- * A list of DNS search domains that are presented to the container.
- */
- DnsSearchDomains?: NonEmptyStringList;
- /**
- * A list of DNS servers that are presented to the container.
- */
- DnsServers?: NonEmptyStringList;
- /**
- * A key-value map of labels to add to the container.
- */
- DockerLabels?: FieldMap;
- /**
- * A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.
- */
- DockerSecurityOptions?: NonEmptyStringList;
- /**
- * The entry point that is passed to the container.
- */
- EntryPoint?: NonEmptyStringList;
- /**
- * The environment variables to pass to a container.
- */
- Environment?: AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList;
- /**
- * A list of files containing the environment variables to pass to a container.
- */
- EnvironmentFiles?: AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList;
- /**
- * Whether the container is essential. All tasks must have at least one essential container.
- */
- Essential?: Boolean;
- /**
- * A list of hostnames and IP address mappings to append to the /etc/hosts file on the container.
- */
- ExtraHosts?: AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList;
- /**
- * The FireLens configuration for the container. Specifies and configures a log router for container logs.
- */
- FirelensConfiguration?: AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails;
- /**
- * The container health check command and associated configuration parameters for the container.
- */
- HealthCheck?: AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails;
- /**
- * The hostname to use for the container.
- */
- Hostname?: NonEmptyString;
- /**
- * The image used to start the container.
- */
- Image?: NonEmptyString;
- /**
- * If set to true, then containerized applications can be deployed that require stdin or a tty to be allocated.
- */
- Interactive?: Boolean;
- /**
- * A list of links for the container in the form container_name:alias . Allows containers to communicate with each other without the need for port mappings.
- */
- Links?: NonEmptyStringList;
- /**
- * Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
- */
- LinuxParameters?: AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails;
- /**
- * The log configuration specification for the container.
- */
- LogConfiguration?: AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails;
- /**
- * The amount (in MiB) of memory to present to the container. If the container attempts to exceed the memory specified here, the container is shut down. The total amount of memory reserved for all containers within a task must be lower than the task memory value, if one is specified.
- */
- Memory?: Integer;
- /**
- * The soft limit (in MiB) of memory to reserve for the container.
- */
- MemoryReservation?: Integer;
- /**
- * The mount points for the data volumes in the container.
- */
- MountPoints?: AwsEcsTaskDefinitionContainerDefinitionsMountPointsList;
- /**
- * The name of the container.
- */
- Name?: NonEmptyString;
- /**
- * The list of port mappings for the container.
- */
- PortMappings?: AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList;
- /**
- * Whether the container is given elevated privileges on the host container instance. The elevated privileges are similar to the root user.
- */
- Privileged?: Boolean;
- /**
- * Whether to allocate a TTY to the container.
- */
- PseudoTerminal?: Boolean;
- /**
- * Whether the container is given read-only access to its root file system.
- */
- ReadonlyRootFilesystem?: Boolean;
- /**
- * The private repository authentication credentials to use.
- */
- RepositoryCredentials?: AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails;
- /**
- * The type and amount of a resource to assign to a container. The only supported resource is a GPU.
- */
- ResourceRequirements?: AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList;
- /**
- * The secrets to pass to the container.
- */
- Secrets?: AwsEcsTaskDefinitionContainerDefinitionsSecretsList;
- /**
- * The number of seconds to wait before giving up on resolving dependencies for a container.
- */
- StartTimeout?: Integer;
- /**
- * The number of seconds to wait before the container is stopped if it doesn't shut down normally on its own.
- */
- StopTimeout?: Integer;
- /**
- * A list of namespaced kernel parameters to set in the container.
- */
- SystemControls?: AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList;
- /**
- * A list of ulimits to set in the container.
- */
- Ulimits?: AwsEcsTaskDefinitionContainerDefinitionsUlimitsList;
- /**
- * The user to use inside the container. The value can use one of the following formats. user user : group uid uid : gid user : gid uid : group
- */
- User?: NonEmptyString;
- /**
- * Data volumes to mount from another container.
- */
- VolumesFrom?: AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList;
- /**
- * The working directory in which to run commands inside the container.
- */
- WorkingDirectory?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails {
- /**
- * The name of the environment variable.
- */
- Name?: NonEmptyString;
- /**
- * The value of the environment variable.
- */
- Value?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails {
- /**
- * The type of environment file. The valid value is s3.
- */
- Type?: NonEmptyString;
- /**
- * The ARN of the S3 object that contains the environment variable file.
- */
- Value?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesList = AwsEcsTaskDefinitionContainerDefinitionsEnvironmentFilesDetails[];
- export type AwsEcsTaskDefinitionContainerDefinitionsEnvironmentList = AwsEcsTaskDefinitionContainerDefinitionsEnvironmentDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails {
- /**
- * The hostname to use in the /etc/hosts entry.
- */
- Hostname?: NonEmptyString;
- /**
- * The IP address to use in the /etc/hosts entry.
- */
- IpAddress?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsExtraHostsList = AwsEcsTaskDefinitionContainerDefinitionsExtraHostsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsFirelensConfigurationDetails {
- /**
- * The options to use to configure the log router. The valid option keys are as follows: enable-ecs-log-metadata. The value can be true or false. config-file-type. The value can be s3 or file. config-file-value. The value is either an S3 ARN or a file path.
- */
- Options?: FieldMap;
- /**
- * The log router to use. Valid values are fluentbit or fluentd.
- */
- Type?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails {
- /**
- * The command that the container runs to determine whether it is healthy.
- */
- Command?: NonEmptyStringList;
- /**
- * The time period in seconds between each health check execution. The default value is 30 seconds.
- */
- Interval?: Integer;
- /**
- * The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.
- */
- Retries?: Integer;
- /**
- * The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.
- */
- StartPeriod?: Integer;
- /**
- * The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.
- */
- Timeout?: Integer;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails {
- /**
- * The Linux capabilities for the container that are added to the default configuration provided by Docker. Valid values are as follows: Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
- */
- Add?: NonEmptyStringList;
- /**
- * The Linux capabilities for the container that are dropped from the default configuration provided by Docker. Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"
- */
- Drop?: NonEmptyStringList;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDetails {
- /**
- * The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker.
- */
- Capabilities?: AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersCapabilitiesDetails;
- /**
- * The host devices to expose to the container.
- */
- Devices?: AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList;
- /**
- * Whether to run an init process inside the container that forwards signals and reaps processes.
- */
- InitProcessEnabled?: Boolean;
- /**
- * The total amount of swap memory (in MiB) that a container can use.
- */
- MaxSwap?: Integer;
- /**
- * The value for the size (in MiB) of the /dev/shm volume.
- */
- SharedMemorySize?: Integer;
- /**
- * Configures the container's memory swappiness behavior. Determines how aggressively pages are swapped. The higher the value, the more aggressive the swappiness. The default is 60.
- */
- Swappiness?: Integer;
- /**
- * The container path, mount options, and size (in MiB) of the tmpfs mount.
- */
- Tmpfs?: AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails {
- /**
- * The path inside the container at which to expose the host device.
- */
- ContainerPath?: NonEmptyString;
- /**
- * The path for the device on the host container instance.
- */
- HostPath?: NonEmptyString;
- /**
- * The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.
- */
- Permissions?: NonEmptyStringList;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesList = AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersDevicesDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails {
- /**
- * The absolute file path where the tmpfs volume is to be mounted.
- */
- ContainerPath?: NonEmptyString;
- /**
- * The list of tmpfs volume mount options. Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"
- */
- MountOptions?: NonEmptyStringList;
- /**
- * The maximum size (in MiB) of the tmpfs volume.
- */
- Size?: Integer;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsList = AwsEcsTaskDefinitionContainerDefinitionsLinuxParametersTmpfsDetails[];
- export type AwsEcsTaskDefinitionContainerDefinitionsList = AwsEcsTaskDefinitionContainerDefinitionsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationDetails {
- /**
- * The log driver to use for the container. Valid values on Fargate are as follows: awsfirelens awslogs splunk Valid values on Amazon EC2 are as follows: awsfirelens awslogs fluentd gelf journald json-file logentries splunk syslog
- */
- LogDriver?: NonEmptyString;
- /**
- * The configuration options to send to the log driver. Requires version 1.19 of the Docker Remote API or greater on your container instance.
- */
- Options?: FieldMap;
- /**
- * The secrets to pass to the log configuration.
- */
- SecretOptions?: AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails {
- /**
- * The name of the secret.
- */
- Name?: NonEmptyString;
- /**
- * The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.
- */
- ValueFrom?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsList = AwsEcsTaskDefinitionContainerDefinitionsLogConfigurationSecretOptionsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails {
- /**
- * The path on the container to mount the host volume at.
- */
- ContainerPath?: NonEmptyString;
- /**
- * Whether the container has read-only access to the volume.
- */
- ReadOnly?: Boolean;
- /**
- * The name of the volume to mount. Must match the name of a volume listed in VolumeDetails for the task definition.
- */
- SourceVolume?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsMountPointsList = AwsEcsTaskDefinitionContainerDefinitionsMountPointsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails {
- /**
- * The port number on the container that is bound to the user-specified or automatically assigned host port.
- */
- ContainerPort?: Integer;
- /**
- * The port number on the container instance to reserve for the container.
- */
- HostPort?: Integer;
- /**
- * The protocol used for the port mapping. The default is tcp.
- */
- Protocol?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsPortMappingsList = AwsEcsTaskDefinitionContainerDefinitionsPortMappingsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsRepositoryCredentialsDetails {
- /**
- * The ARN of the secret that contains the private repository credentials.
- */
- CredentialsParameter?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails {
- /**
- * The type of resource to assign to a container. Valid values are GPU or InferenceAccelerator.
- */
- Type?: NonEmptyString;
- /**
- * The value for the specified resource type. For GPU, the value is the number of physical GPUs the Amazon ECS container agent reserves for the container. For InferenceAccelerator, the value should match the DeviceName attribute of an entry in InferenceAccelerators.
- */
- Value?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsList = AwsEcsTaskDefinitionContainerDefinitionsResourceRequirementsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails {
- /**
- * The name of the secret.
- */
- Name?: NonEmptyString;
- /**
- * The secret to expose to the container. The value is either the full ARN of the Secrets Manager secret or the full ARN of the parameter in the Systems Manager Parameter Store.
- */
- ValueFrom?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsSecretsList = AwsEcsTaskDefinitionContainerDefinitionsSecretsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails {
- /**
- * The namespaced kernel parameter for which to set a value.
- */
- Namespace?: NonEmptyString;
- /**
- * The value of the parameter.
- */
- Value?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsSystemControlsList = AwsEcsTaskDefinitionContainerDefinitionsSystemControlsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails {
- /**
- * The hard limit for the ulimit type.
- */
- HardLimit?: Integer;
- /**
- * The type of the ulimit. Valid values are as follows: core cpu data fsize locks memlock msgqueue nice nofile nproc rss rtprio rttime sigpending stack
- */
- Name?: NonEmptyString;
- /**
- * The soft limit for the ulimit type.
- */
- SoftLimit?: Integer;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsUlimitsList = AwsEcsTaskDefinitionContainerDefinitionsUlimitsDetails[];
- export interface AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails {
- /**
- * Whether the container has read-only access to the volume.
- */
- ReadOnly?: Boolean;
- /**
- * The name of another container within the same task definition from which to mount volumes.
- */
- SourceContainer?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionContainerDefinitionsVolumesFromList = AwsEcsTaskDefinitionContainerDefinitionsVolumesFromDetails[];
- export interface AwsEcsTaskDefinitionDetails {
- /**
- * The container definitions that describe the containers that make up the task.
- */
- ContainerDefinitions?: AwsEcsTaskDefinitionContainerDefinitionsList;
- /**
- * The number of CPU units used by the task.Valid values are as follows: 256 (.25 vCPU) 512 (.5 vCPU) 1024 (1 vCPU) 2048 (2 vCPU) 4096 (4 vCPU)
- */
- Cpu?: NonEmptyString;
- /**
- * The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.
- */
- ExecutionRoleArn?: NonEmptyString;
- /**
- * The name of a family that this task definition is registered to.
- */
- Family?: NonEmptyString;
- /**
- * The Elastic Inference accelerators to use for the containers in the task.
- */
- InferenceAccelerators?: AwsEcsTaskDefinitionInferenceAcceleratorsList;
- /**
- * The inter-process communication (IPC) resource namespace to use for the containers in the task. Valid values are as follows: host none task
- */
- IpcMode?: NonEmptyString;
- /**
- * The amount (in MiB) of memory used by the task. For tasks that are hosted on Amazon EC2, you can provide a task-level memory value or a container-level memory value. For tasks that are hosted on Fargate, you must use one of the specified values in the Amazon Elastic Container Service Developer Guide , which determines your range of supported values for the Cpu and Memory parameters.
- */
- Memory?: NonEmptyString;
- /**
- * The Docker networking mode to use for the containers in the task. Valid values are as follows: awsvpc bridge host none
- */
- NetworkMode?: NonEmptyString;
- /**
- * The process namespace to use for the containers in the task. Valid values are host or task.
- */
- PidMode?: NonEmptyString;
- /**
- * The placement constraint objects to use for tasks.
- */
- PlacementConstraints?: AwsEcsTaskDefinitionPlacementConstraintsList;
- /**
- * The configuration details for the App Mesh proxy.
- */
- ProxyConfiguration?: AwsEcsTaskDefinitionProxyConfigurationDetails;
- /**
- * The task launch types that the task definition was validated against.
- */
- RequiresCompatibilities?: NonEmptyStringList;
- /**
- * The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.
- */
- TaskRoleArn?: NonEmptyString;
- /**
- * The data volume definitions for the task.
- */
- Volumes?: AwsEcsTaskDefinitionVolumesList;
- /**
- * The status of the task definition.
- */
- Status?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionInferenceAcceleratorsDetails {
- /**
- * The Elastic Inference accelerator device name.
- */
- DeviceName?: NonEmptyString;
- /**
- * The Elastic Inference accelerator type to use.
- */
- DeviceType?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionInferenceAcceleratorsList = AwsEcsTaskDefinitionInferenceAcceleratorsDetails[];
- export interface AwsEcsTaskDefinitionPlacementConstraintsDetails {
- /**
- * A cluster query language expression to apply to the constraint.
- */
- Expression?: NonEmptyString;
- /**
- * The type of constraint.
- */
- Type?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionPlacementConstraintsList = AwsEcsTaskDefinitionPlacementConstraintsDetails[];
- export interface AwsEcsTaskDefinitionProxyConfigurationDetails {
- /**
- * The name of the container that will serve as the App Mesh proxy.
- */
- ContainerName?: NonEmptyString;
- /**
- * The set of network configuration parameters to provide to the Container Network Interface (CNI) plugin, specified as key-value pairs.
- */
- ProxyConfigurationProperties?: AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList;
- /**
- * The proxy type.
- */
- Type?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails {
- /**
- * The name of the property.
- */
- Name?: NonEmptyString;
- /**
- * The value of the property.
- */
- Value?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesList = AwsEcsTaskDefinitionProxyConfigurationProxyConfigurationPropertiesDetails[];
- export interface AwsEcsTaskDefinitionVolumesDetails {
- /**
- * Information about a Docker volume.
- */
- DockerVolumeConfiguration?: AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails;
- /**
- * Information about the Amazon Elastic File System file system that is used for task storage.
- */
- EfsVolumeConfiguration?: AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails;
- /**
- * Information about a bind mount host volume.
- */
- Host?: AwsEcsTaskDefinitionVolumesHostDetails;
- /**
- * The name of the data volume.
- */
- Name?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionVolumesDockerVolumeConfigurationDetails {
- /**
- * Whether to create the Docker volume automatically if it does not already exist.
- */
- Autoprovision?: Boolean;
- /**
- * The Docker volume driver to use.
- */
- Driver?: NonEmptyString;
- /**
- * A map of Docker driver-specific options that are passed through.
- */
- DriverOpts?: FieldMap;
- /**
- * Custom metadata to add to the Docker volume.
- */
- Labels?: FieldMap;
- /**
- * The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a task are provisioned automatically when the task starts and destroyed when the task stops. Docker volumes that are shared persist after the task stops. Valid values are shared or task.
- */
- Scope?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails {
- /**
- * The Amazon EFS access point identifier to use.
- */
- AccessPointId?: NonEmptyString;
- /**
- * Whether to use the Amazon ECS task IAM role defined in a task definition when mounting the Amazon EFS file system.
- */
- Iam?: NonEmptyString;
- }
- export interface AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationDetails {
- /**
- * The authorization configuration details for the Amazon EFS file system.
- */
- AuthorizationConfig?: AwsEcsTaskDefinitionVolumesEfsVolumeConfigurationAuthorizationConfigDetails;
- /**
- * The Amazon EFS file system identifier to use.
- */
- FilesystemId?: NonEmptyString;
- /**
- * The directory within the Amazon EFS file system to mount as the root directory inside the host.
- */
- RootDirectory?: NonEmptyString;
- /**
- * Whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
- */
- TransitEncryption?: NonEmptyString;
- /**
- * The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server.
- */
- TransitEncryptionPort?: Integer;
- }
- export interface AwsEcsTaskDefinitionVolumesHostDetails {
- /**
- * The path on the host container instance that is presented to the container.
- */
- SourcePath?: NonEmptyString;
- }
- export type AwsEcsTaskDefinitionVolumesList = AwsEcsTaskDefinitionVolumesDetails[];
- export interface AwsEcsTaskDetails {
- /**
- * The Amazon Resource Name (ARN) of the cluster that hosts the task.
- */
- ClusterArn?: NonEmptyString;
- /**
- * The ARN of the task definition that creates the task.
- */
- TaskDefinitionArn?: NonEmptyString;
- /**
- * The version counter for the task.
- */
- Version?: NonEmptyString;
- /**
- * The Unix timestamp for the time when the task was created. More specifically, it's for the time when the task entered the PENDING state.
- */
- CreatedAt?: NonEmptyString;
- /**
- * The Unix timestamp for the time when the task started. More specifically, it's for the time when the task transitioned from the PENDING state to the RUNNING state.
- */
- StartedAt?: NonEmptyString;
- /**
- * The tag specified when a task is started. If an Amazon ECS service started the task, the startedBy parameter contains the deployment ID of that service.
- */
- StartedBy?: NonEmptyString;
- /**
- * The name of the task group that's associated with the task.
- */
- Group?: NonEmptyString;
- /**
- * Details about the data volume that is used in a task definition.
- */
- Volumes?: AwsEcsTaskVolumeDetailsList;
- /**
- * The containers that are associated with the task.
- */
- Containers?: AwsEcsContainerDetailsList;
- }
- export interface AwsEcsTaskVolumeDetails {
- /**
- * The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.
- */
- Name?: NonEmptyString;
- /**
- * This parameter is specified when you use bind mount host volumes. The contents of the host parameter determine whether your bind mount host volume persists on the host container instance and where it's stored.
- */
- Host?: AwsEcsTaskVolumeHostDetails;
- }
- export type AwsEcsTaskVolumeDetailsList = AwsEcsTaskVolumeDetails[];
- export interface AwsEcsTaskVolumeHostDetails {
- /**
- * When the host parameter is used, specify a sourcePath to declare the path on the host container instance that's presented to the container.
- */
- SourcePath?: NonEmptyString;
- }
- export interface AwsEfsAccessPointDetails {
- /**
- * The ID of the Amazon EFS access point.
- */
- AccessPointId?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the Amazon EFS access point.
- */
- Arn?: NonEmptyString;
- /**
- * The opaque string specified in the request to ensure idempotent creation.
- */
- ClientToken?: NonEmptyString;
- /**
- * The ID of the Amazon EFS file system that the access point applies to.
- */
- FileSystemId?: NonEmptyString;
- /**
- * The full POSIX identity, including the user ID, group ID, and secondary group IDs on the access point, that is used for all file operations by NFS clients using the access point.
- */
- PosixUser?: AwsEfsAccessPointPosixUserDetails;
- /**
- * The directory on the Amazon EFS file system that the access point exposes as the root directory to NFS clients using the access point.
- */
- RootDirectory?: AwsEfsAccessPointRootDirectoryDetails;
- }
- export interface AwsEfsAccessPointPosixUserDetails {
- /**
- * The POSIX group ID used for all file system operations using this access point.
- */
- Gid?: NonEmptyString;
- /**
- * Secondary POSIX group IDs used for all file system operations using this access point.
- */
- SecondaryGids?: NonEmptyStringList;
- /**
- * The POSIX user ID used for all file system operations using this access point.
- */
- Uid?: NonEmptyString;
- }
- export interface AwsEfsAccessPointRootDirectoryCreationInfoDetails {
- /**
- * Specifies the POSIX group ID to apply to the root directory.
- */
- OwnerGid?: NonEmptyString;
- /**
- * Specifies the POSIX user ID to apply to the root directory.
- */
- OwnerUid?: NonEmptyString;
- /**
- * Specifies the POSIX permissions to apply to the root directory, in the format of an octal number representing the file's mode bits.
- */
- Permissions?: NonEmptyString;
- }
- export interface AwsEfsAccessPointRootDirectoryDetails {
- /**
- * Specifies the POSIX IDs and permissions to apply to the access point's root directory.
- */
- CreationInfo?: AwsEfsAccessPointRootDirectoryCreationInfoDetails;
- /**
- * Specifies the path on the Amazon EFS file system to expose as the root directory to NFS clients using the access point to access the EFS file system. A path can have up to four subdirectories. If the specified path does not exist, you are required to provide CreationInfo.
- */
- Path?: NonEmptyString;
- }
- export interface AwsEksClusterDetails {
- /**
- * The ARN of the cluster.
- */
- Arn?: NonEmptyString;
- /**
- * The certificate authority data for the cluster.
- */
- CertificateAuthorityData?: NonEmptyString;
- /**
- * The status of the cluster. Valid values are as follows: ACTIVE CREATING DELETING FAILED PENDING UPDATING
- */
- ClusterStatus?: NonEmptyString;
- /**
- * The endpoint for the Amazon EKS API server.
- */
- Endpoint?: NonEmptyString;
- /**
- * The name of the cluster.
- */
- Name?: NonEmptyString;
- /**
- * The VPC configuration used by the cluster control plane.
- */
- ResourcesVpcConfig?: AwsEksClusterResourcesVpcConfigDetails;
- /**
- * The ARN of the IAM role that provides permissions for the Amazon EKS control plane to make calls to Amazon Web Services API operations on your behalf.
- */
- RoleArn?: NonEmptyString;
- /**
- * The Amazon EKS server version for the cluster.
- */
- Version?: NonEmptyString;
- /**
- * The logging configuration for the cluster.
- */
- Logging?: AwsEksClusterLoggingDetails;
- }
- export interface AwsEksClusterLoggingClusterLoggingDetails {
- /**
- * Whether the logging types that are listed in Types are enabled.
- */
- Enabled?: Boolean;
- /**
- * A list of logging types. Valid values are as follows: api audit authenticator controllerManager scheduler
- */
- Types?: NonEmptyStringList;
- }
- export type AwsEksClusterLoggingClusterLoggingList = AwsEksClusterLoggingClusterLoggingDetails[];
- export interface AwsEksClusterLoggingDetails {
- /**
- * Cluster logging configurations.
- */
- ClusterLogging?: AwsEksClusterLoggingClusterLoggingList;
- }
- export interface AwsEksClusterResourcesVpcConfigDetails {
- /**
- * The security groups that are associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Amazon EKS control plane.
- */
- SecurityGroupIds?: NonEmptyStringList;
- /**
- * The subnets that are associated with the cluster.
- */
- SubnetIds?: NonEmptyStringList;
- /**
- * Indicates whether the Amazon EKS public API server endpoint is turned on. If the Amazon EKS public API server endpoint is turned off, your cluster's Kubernetes API server can only receive requests that originate from within the cluster VPC.
- */
- EndpointPublicAccess?: Boolean;
- }
- export interface AwsElasticBeanstalkEnvironmentDetails {
- /**
- * The name of the application that is associated with the environment.
- */
- ApplicationName?: NonEmptyString;
- /**
- * The URL to the CNAME for this environment.
- */
- Cname?: NonEmptyString;
- /**
- * The creation date for this environment.
- */
- DateCreated?: NonEmptyString;
- /**
- * The date when this environment was last modified.
- */
- DateUpdated?: NonEmptyString;
- /**
- * A description of the environment.
- */
- Description?: NonEmptyString;
- /**
- * For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.
- */
- EndpointUrl?: NonEmptyString;
- /**
- * The ARN of the environment.
- */
- EnvironmentArn?: NonEmptyString;
- /**
- * The identifier of the environment.
- */
- EnvironmentId?: NonEmptyString;
- /**
- * Links to other environments in the same group.
- */
- EnvironmentLinks?: AwsElasticBeanstalkEnvironmentEnvironmentLinks;
- /**
- * The name of the environment.
- */
- EnvironmentName?: NonEmptyString;
- /**
- * The configuration setting for the environment.
- */
- OptionSettings?: AwsElasticBeanstalkEnvironmentOptionSettings;
- /**
- * The ARN of the platform version for the environment.
- */
- PlatformArn?: NonEmptyString;
- /**
- * The name of the solution stack that is deployed with the environment.
- */
- SolutionStackName?: NonEmptyString;
- /**
- * The current operational status of the environment. Valid values are as follows: Aborting Launching LinkingFrom LinkingTo Ready Terminated Terminating Updating
- */
- Status?: NonEmptyString;
- /**
- * The tier of the environment.
- */
- Tier?: AwsElasticBeanstalkEnvironmentTier;
- /**
- * The application version of the environment.
- */
- VersionLabel?: NonEmptyString;
- }
- export interface AwsElasticBeanstalkEnvironmentEnvironmentLink {
- /**
- * The name of the linked environment.
- */
- EnvironmentName?: NonEmptyString;
- /**
- * The name of the environment link.
- */
- LinkName?: NonEmptyString;
- }
- export type AwsElasticBeanstalkEnvironmentEnvironmentLinks = AwsElasticBeanstalkEnvironmentEnvironmentLink[];
- export interface AwsElasticBeanstalkEnvironmentOptionSetting {
- /**
- * The type of resource that the configuration option is associated with.
- */
- Namespace?: NonEmptyString;
- /**
- * The name of the option.
- */
- OptionName?: NonEmptyString;
- /**
- * The name of the resource.
- */
- ResourceName?: NonEmptyString;
- /**
- * The value of the configuration setting.
- */
- Value?: NonEmptyString;
- }
- export type AwsElasticBeanstalkEnvironmentOptionSettings = AwsElasticBeanstalkEnvironmentOptionSetting[];
- export interface AwsElasticBeanstalkEnvironmentTier {
- /**
- * The name of the environment tier. Valid values are WebServer or Worker.
- */
- Name?: NonEmptyString;
- /**
- * The type of environment tier. Valid values are Standard or SQS/HTTP.
- */
- Type?: NonEmptyString;
- /**
- * The version of the environment tier.
- */
- Version?: NonEmptyString;
- }
- export interface AwsElasticsearchDomainDetails {
- /**
- * IAM policy document specifying the access policies for the new Elasticsearch domain.
- */
- AccessPolicies?: NonEmptyString;
- /**
- * Additional options for the domain endpoint.
- */
- DomainEndpointOptions?: AwsElasticsearchDomainDomainEndpointOptions;
- /**
- * Unique identifier for an Elasticsearch domain.
- */
- DomainId?: NonEmptyString;
- /**
- * Name of an Elasticsearch domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region. Domain names must start with a lowercase letter and must be between 3 and 28 characters. Valid characters are a-z (lowercase only), 0-9, and – (hyphen).
- */
- DomainName?: NonEmptyString;
- /**
- * Domain-specific endpoint used to submit index, search, and data upload requests to an Elasticsearch domain. The endpoint is a service URL.
- */
- Endpoint?: NonEmptyString;
- /**
- * The key-value pair that exists if the Elasticsearch domain uses VPC endpoints.
- */
- Endpoints?: FieldMap;
- /**
- * OpenSearch version.
- */
- ElasticsearchVersion?: NonEmptyString;
- /**
- * Information about an OpenSearch cluster configuration.
- */
- ElasticsearchClusterConfig?: AwsElasticsearchDomainElasticsearchClusterConfigDetails;
- /**
- * Details about the configuration for encryption at rest.
- */
- EncryptionAtRestOptions?: AwsElasticsearchDomainEncryptionAtRestOptions;
- /**
- * Configures the CloudWatch Logs to publish for the Elasticsearch domain.
- */
- LogPublishingOptions?: AwsElasticsearchDomainLogPublishingOptions;
- /**
- * Details about the configuration for node-to-node encryption.
- */
- NodeToNodeEncryptionOptions?: AwsElasticsearchDomainNodeToNodeEncryptionOptions;
- /**
- * Information about the status of a domain relative to the latest service software.
- */
- ServiceSoftwareOptions?: AwsElasticsearchDomainServiceSoftwareOptions;
- /**
- * Information that OpenSearch derives based on VPCOptions for the domain.
- */
- VPCOptions?: AwsElasticsearchDomainVPCOptions;
- }
- export interface AwsElasticsearchDomainDomainEndpointOptions {
- /**
- * Whether to require that all traffic to the domain arrive over HTTPS.
- */
- EnforceHTTPS?: Boolean;
- /**
- * The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain. Valid values: Policy-Min-TLS-1-0-2019-07, which supports TLSv1.0 and higher Policy-Min-TLS-1-2-2019-07, which only supports TLSv1.2
- */
- TLSSecurityPolicy?: NonEmptyString;
- }
- export interface AwsElasticsearchDomainElasticsearchClusterConfigDetails {
- /**
- * The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
- */
- DedicatedMasterCount?: Integer;
- /**
- * Whether to use a dedicated master node for the Elasticsearch domain. A dedicated master node performs cluster management tasks, but doesn't hold data or respond to data upload requests.
- */
- DedicatedMasterEnabled?: Boolean;
- /**
- * The hardware configuration of the computer that hosts the dedicated master node. A sample value is m3.medium.elasticsearch. If this attribute is specified, then DedicatedMasterEnabled must be true. For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
- */
- DedicatedMasterType?: NonEmptyString;
- /**
- * The number of data nodes to use in the Elasticsearch domain.
- */
- InstanceCount?: Integer;
- /**
- * The instance type for your data nodes. For example, m3.medium.elasticsearch. For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
- */
- InstanceType?: NonEmptyString;
- /**
- * Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
- */
- ZoneAwarenessConfig?: AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails;
- /**
- * Whether to enable zone awareness for the Elasticsearch domain. When zone awareness is enabled, OpenSearch allocates the cluster's nodes and replica index shards across Availability Zones in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
- */
- ZoneAwarenessEnabled?: Boolean;
- }
- export interface AwsElasticsearchDomainElasticsearchClusterConfigZoneAwarenessConfigDetails {
- /**
- * he number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
- */
- AvailabilityZoneCount?: Integer;
- }
- export interface AwsElasticsearchDomainEncryptionAtRestOptions {
- /**
- * Whether encryption at rest is enabled.
- */
- Enabled?: Boolean;
- /**
- * The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.
- */
- KmsKeyId?: NonEmptyString;
- }
- export interface AwsElasticsearchDomainLogPublishingOptions {
- /**
- * Configures the OpenSearch index logs publishing.
- */
- IndexSlowLogs?: AwsElasticsearchDomainLogPublishingOptionsLogConfig;
- /**
- * Configures the OpenSearch search slow log publishing.
- */
- SearchSlowLogs?: AwsElasticsearchDomainLogPublishingOptionsLogConfig;
- AuditLogs?: AwsElasticsearchDomainLogPublishingOptionsLogConfig;
- }
- export interface AwsElasticsearchDomainLogPublishingOptionsLogConfig {
- /**
- * The ARN of the CloudWatch Logs group to publish the logs to.
- */
- CloudWatchLogsLogGroupArn?: NonEmptyString;
- /**
- * Whether the log publishing is enabled.
- */
- Enabled?: Boolean;
- }
- export interface AwsElasticsearchDomainNodeToNodeEncryptionOptions {
- /**
- * Whether node-to-node encryption is enabled.
- */
- Enabled?: Boolean;
- }
- export interface AwsElasticsearchDomainServiceSoftwareOptions {
- /**
- * The epoch time when the deployment window closes for required updates. After this time, Amazon OpenSearch Service schedules the software upgrade automatically.
- */
- AutomatedUpdateDate?: NonEmptyString;
- /**
- * Whether a request to update the domain can be canceled.
- */
- Cancellable?: Boolean;
- /**
- * The version of the service software that is currently installed on the domain.
- */
- CurrentVersion?: NonEmptyString;
- /**
- * A more detailed description of the service software status.
- */
- Description?: NonEmptyString;
- /**
- * The most recent version of the service software.
- */
- NewVersion?: NonEmptyString;
- /**
- * Whether a service software update is available for the domain.
- */
- UpdateAvailable?: Boolean;
- /**
- * The status of the service software update. Valid values are as follows: COMPLETED ELIGIBLE IN_PROGRESS NOT_ELIGIBLE PENDING_UPDATE
- */
- UpdateStatus?: NonEmptyString;
- }
- export interface AwsElasticsearchDomainVPCOptions {
- /**
- * The list of Availability Zones associated with the VPC subnets.
- */
- AvailabilityZones?: NonEmptyStringList;
- /**
- * The list of security group IDs associated with the VPC endpoints for the domain.
- */
- SecurityGroupIds?: NonEmptyStringList;
- /**
- * A list of subnet IDs associated with the VPC endpoints for the domain.
- */
- SubnetIds?: NonEmptyStringList;
- /**
- * ID for the VPC.
- */
- VPCId?: NonEmptyString;
- }
- export type AwsElbAppCookieStickinessPolicies = AwsElbAppCookieStickinessPolicy[];
- export interface AwsElbAppCookieStickinessPolicy {
- /**
- * The name of the application cookie used for stickiness.
- */
- CookieName?: NonEmptyString;
- /**
- * The mnemonic name for the policy being created. The name must be unique within the set of policies for the load balancer.
- */
- PolicyName?: NonEmptyString;
- }
- export type AwsElbLbCookieStickinessPolicies = AwsElbLbCookieStickinessPolicy[];
- export interface AwsElbLbCookieStickinessPolicy {
- /**
- * The amount of time, in seconds, after which the cookie is considered stale. If an expiration period is not specified, the stickiness session lasts for the duration of the browser session.
- */
- CookieExpirationPeriod?: Long;
- /**
- * The name of the policy. The name must be unique within the set of policies for the load balancer.
- */
- PolicyName?: NonEmptyString;
- }
- export interface AwsElbLoadBalancerAccessLog {
- /**
- * The interval in minutes for publishing the access logs. You can publish access logs either every 5 minutes or every 60 minutes.
- */
- EmitInterval?: Integer;
- /**
- * Indicates whether access logs are enabled for the load balancer.
- */
- Enabled?: Boolean;
- /**
- * The name of the S3 bucket where the access logs are stored.
- */
- S3BucketName?: NonEmptyString;
- /**
- * The logical hierarchy that was created for the S3 bucket. If a prefix is not provided, the log is placed at the root level of the bucket.
- */
- S3BucketPrefix?: NonEmptyString;
- }
- export interface AwsElbLoadBalancerAdditionalAttribute {
- /**
- * The name of the attribute.
- */
- Key?: NonEmptyString;
- /**
- * The value of the attribute.
- */
- Value?: NonEmptyString;
- }
- export type AwsElbLoadBalancerAdditionalAttributeList = AwsElbLoadBalancerAdditionalAttribute[];
- export interface AwsElbLoadBalancerAttributes {
- /**
- * Information about the access log configuration for the load balancer. If the access log is enabled, the load balancer captures detailed information about all requests. It delivers the information to a specified S3 bucket.
- */
- AccessLog?: AwsElbLoadBalancerAccessLog;
- /**
- * Information about the connection draining configuration for the load balancer. If connection draining is enabled, the load balancer allows existing requests to complete before it shifts traffic away from a deregistered or unhealthy instance.
- */
- ConnectionDraining?: AwsElbLoadBalancerConnectionDraining;
- /**
- * Connection settings for the load balancer. If an idle timeout is configured, the load balancer allows connections to remain idle for the specified duration. When a connection is idle, no data is sent over the connection.
- */
- ConnectionSettings?: AwsElbLoadBalancerConnectionSettings;
- /**
- * Cross-zone load balancing settings for the load balancer. If cross-zone load balancing is enabled, the load balancer routes the request traffic evenly across all instances regardless of the Availability Zones.
- */
- CrossZoneLoadBalancing?: AwsElbLoadBalancerCrossZoneLoadBalancing;
- /**
- * Any additional attributes for a load balancer.
- */
- AdditionalAttributes?: AwsElbLoadBalancerAdditionalAttributeList;
- }
- export interface AwsElbLoadBalancerBackendServerDescription {
- /**
- * The port on which the EC2 instance is listening.
- */
- InstancePort?: Integer;
- /**
- * The names of the policies that are enabled for the EC2 instance.
- */
- PolicyNames?: StringList;
- }
- export type AwsElbLoadBalancerBackendServerDescriptions = AwsElbLoadBalancerBackendServerDescription[];
- export interface AwsElbLoadBalancerConnectionDraining {
- /**
- * Indicates whether connection draining is enabled for the load balancer.
- */
- Enabled?: Boolean;
- /**
- * The maximum time, in seconds, to keep the existing connections open before deregistering the instances.
- */
- Timeout?: Integer;
- }
- export interface AwsElbLoadBalancerConnectionSettings {
- /**
- * The time, in seconds, that the connection can be idle (no data is sent over the connection) before it is closed by the load balancer.
- */
- IdleTimeout?: Integer;
- }
- export interface AwsElbLoadBalancerCrossZoneLoadBalancing {
- /**
- * Indicates whether cross-zone load balancing is enabled for the load balancer.
- */
- Enabled?: Boolean;
- }
- export interface AwsElbLoadBalancerDetails {
- /**
- * The list of Availability Zones for the load balancer.
- */
- AvailabilityZones?: StringList;
- /**
- * Information about the configuration of the EC2 instances.
- */
- BackendServerDescriptions?: AwsElbLoadBalancerBackendServerDescriptions;
- /**
- * The name of the Amazon Route 53 hosted zone for the load balancer.
- */
- CanonicalHostedZoneName?: NonEmptyString;
- /**
- * The ID of the Amazon Route 53 hosted zone for the load balancer.
- */
- CanonicalHostedZoneNameID?: NonEmptyString;
- /**
- * Indicates when the load balancer was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedTime?: NonEmptyString;
- /**
- * The DNS name of the load balancer.
- */
- DnsName?: NonEmptyString;
- /**
- * Information about the health checks that are conducted on the load balancer.
- */
- HealthCheck?: AwsElbLoadBalancerHealthCheck;
- /**
- * List of EC2 instances for the load balancer.
- */
- Instances?: AwsElbLoadBalancerInstances;
- /**
- * The policies that are enabled for the load balancer listeners.
- */
- ListenerDescriptions?: AwsElbLoadBalancerListenerDescriptions;
- /**
- * The attributes for a load balancer.
- */
- LoadBalancerAttributes?: AwsElbLoadBalancerAttributes;
- /**
- * The name of the load balancer.
- */
- LoadBalancerName?: NonEmptyString;
- /**
- * The policies for a load balancer.
- */
- Policies?: AwsElbLoadBalancerPolicies;
- /**
- * The type of load balancer. Only provided if the load balancer is in a VPC. If Scheme is internet-facing, the load balancer has a public DNS name that resolves to a public IP address. If Scheme is internal, the load balancer has a public DNS name that resolves to a private IP address.
- */
- Scheme?: NonEmptyString;
- /**
- * The security groups for the load balancer. Only provided if the load balancer is in a VPC.
- */
- SecurityGroups?: StringList;
- /**
- * Information about the security group for the load balancer. This is the security group that is used for inbound rules.
- */
- SourceSecurityGroup?: AwsElbLoadBalancerSourceSecurityGroup;
- /**
- * The list of subnet identifiers for the load balancer.
- */
- Subnets?: StringList;
- /**
- * The identifier of the VPC for the load balancer.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsElbLoadBalancerHealthCheck {
- /**
- * The number of consecutive health check successes required before the instance is moved to the Healthy state.
- */
- HealthyThreshold?: Integer;
- /**
- * The approximate interval, in seconds, between health checks of an individual instance.
- */
- Interval?: Integer;
- /**
- * The instance that is being checked. The target specifies the protocol and port. The available protocols are TCP, SSL, HTTP, and HTTPS. The range of valid ports is 1 through 65535. For the HTTP and HTTPS protocols, the target also specifies the ping path. For the TCP protocol, the target is specified as TCP: <port> . For the SSL protocol, the target is specified as SSL.<port> . For the HTTP and HTTPS protocols, the target is specified as <protocol>:<port>/<path to ping> .
- */
- Target?: NonEmptyString;
- /**
- * The amount of time, in seconds, during which no response means a failed health check.
- */
- Timeout?: Integer;
- /**
- * The number of consecutive health check failures that must occur before the instance is moved to the Unhealthy state.
- */
- UnhealthyThreshold?: Integer;
- }
- export interface AwsElbLoadBalancerInstance {
- /**
- * The instance identifier.
- */
- InstanceId?: NonEmptyString;
- }
- export type AwsElbLoadBalancerInstances = AwsElbLoadBalancerInstance[];
- export interface AwsElbLoadBalancerListener {
- /**
- * The port on which the instance is listening.
- */
- InstancePort?: Integer;
- /**
- * The protocol to use to route traffic to instances. Valid values: HTTP | HTTPS | TCP | SSL
- */
- InstanceProtocol?: NonEmptyString;
- /**
- * The port on which the load balancer is listening. On EC2-VPC, you can specify any port from the range 1-65535. On EC2-Classic, you can specify any port from the following list: 25, 80, 443, 465, 587, 1024-65535.
- */
- LoadBalancerPort?: Integer;
- /**
- * The load balancer transport protocol to use for routing. Valid values: HTTP | HTTPS | TCP | SSL
- */
- Protocol?: NonEmptyString;
- /**
- * The ARN of the server certificate.
- */
- SslCertificateId?: NonEmptyString;
- }
- export interface AwsElbLoadBalancerListenerDescription {
- /**
- * Information about the listener.
- */
- Listener?: AwsElbLoadBalancerListener;
- /**
- * The policies enabled for the listener.
- */
- PolicyNames?: StringList;
- }
- export type AwsElbLoadBalancerListenerDescriptions = AwsElbLoadBalancerListenerDescription[];
- export interface AwsElbLoadBalancerPolicies {
- /**
- * The stickiness policies that are created using CreateAppCookieStickinessPolicy.
- */
- AppCookieStickinessPolicies?: AwsElbAppCookieStickinessPolicies;
- /**
- * The stickiness policies that are created using CreateLBCookieStickinessPolicy.
- */
- LbCookieStickinessPolicies?: AwsElbLbCookieStickinessPolicies;
- /**
- * The policies other than the stickiness policies.
- */
- OtherPolicies?: StringList;
- }
- export interface AwsElbLoadBalancerSourceSecurityGroup {
- /**
- * The name of the security group.
- */
- GroupName?: NonEmptyString;
- /**
- * The owner of the security group.
- */
- OwnerAlias?: NonEmptyString;
- }
- export interface AwsElbv2LoadBalancerAttribute {
- /**
- * The name of the load balancer attribute.
- */
- Key?: NonEmptyString;
- /**
- * The value of the load balancer attribute.
- */
- Value?: NonEmptyString;
- }
- export type AwsElbv2LoadBalancerAttributes = AwsElbv2LoadBalancerAttribute[];
- export interface AwsElbv2LoadBalancerDetails {
- /**
- * The Availability Zones for the load balancer.
- */
- AvailabilityZones?: AvailabilityZones;
- /**
- * The ID of the Amazon Route 53 hosted zone associated with the load balancer.
- */
- CanonicalHostedZoneId?: NonEmptyString;
- /**
- * Indicates when the load balancer was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedTime?: NonEmptyString;
- /**
- * The public DNS name of the load balancer.
- */
- DNSName?: NonEmptyString;
- /**
- * The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 (for IPv4 addresses) and dualstack (for IPv4 and IPv6 addresses).
- */
- IpAddressType?: NonEmptyString;
- /**
- * The nodes of an Internet-facing load balancer have public IP addresses.
- */
- Scheme?: NonEmptyString;
- /**
- * The IDs of the security groups for the load balancer.
- */
- SecurityGroups?: SecurityGroups;
- /**
- * The state of the load balancer.
- */
- State?: LoadBalancerState;
- /**
- * The type of load balancer.
- */
- Type?: NonEmptyString;
- /**
- * The ID of the VPC for the load balancer.
- */
- VpcId?: NonEmptyString;
- /**
- * Attributes of the load balancer.
- */
- LoadBalancerAttributes?: AwsElbv2LoadBalancerAttributes;
- }
- export interface AwsEventSchemasRegistryDetails {
- /**
- * A description of the registry to be created.
- */
- Description?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the registry.
- */
- RegistryArn?: NonEmptyString;
- /**
- * The name of the schema registry.
- */
- RegistryName?: NonEmptyString;
- }
- export interface AwsEventsEndpointDetails {
- /**
- * The Amazon Resource Name (ARN) of the endpoint.
- */
- Arn?: NonEmptyString;
- /**
- * A description of the endpoint.
- */
- Description?: NonEmptyString;
- /**
- * The URL subdomain of the endpoint. For example, if EndpointUrl is https://abcde.veo.endpoints.event.amazonaws.com, then the EndpointId is abcde.veo.
- */
- EndpointId?: NonEmptyString;
- /**
- * The URL of the endpoint.
- */
- EndpointUrl?: NonEmptyString;
- /**
- * The event buses being used by the endpoint.
- */
- EventBuses?: AwsEventsEndpointEventBusesList;
- /**
- * The name of the endpoint.
- */
- Name?: NonEmptyString;
- /**
- * Whether event replication was enabled or disabled for this endpoint. The default state is ENABLED, which means you must supply a RoleArn. If you don't have a RoleArn or you don't want event replication enabled, set the state to DISABLED.
- */
- ReplicationConfig?: AwsEventsEndpointReplicationConfigDetails;
- /**
- * The ARN of the role used by event replication for the endpoint.
- */
- RoleArn?: NonEmptyString;
- /**
- * The routing configuration of the endpoint.
- */
- RoutingConfig?: AwsEventsEndpointRoutingConfigDetails;
- /**
- * The current state of the endpoint.
- */
- State?: NonEmptyString;
- /**
- * The reason the endpoint is in its current state.
- */
- StateReason?: NonEmptyString;
- }
- export interface AwsEventsEndpointEventBusesDetails {
- /**
- * The Amazon Resource Name (ARN) of the event bus that the endpoint is associated with.
- */
- EventBusArn?: NonEmptyString;
- }
- export type AwsEventsEndpointEventBusesList = AwsEventsEndpointEventBusesDetails[];
- export interface AwsEventsEndpointReplicationConfigDetails {
- /**
- * The state of event replication.
- */
- State?: NonEmptyString;
- }
- export interface AwsEventsEndpointRoutingConfigDetails {
- /**
- * The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.
- */
- FailoverConfig?: AwsEventsEndpointRoutingConfigFailoverConfigDetails;
- }
- export interface AwsEventsEndpointRoutingConfigFailoverConfigDetails {
- /**
- * The main Region of the endpoint.
- */
- Primary?: AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails;
- /**
- * The Region that events are routed to when failover is triggered or event replication is enabled.
- */
- Secondary?: AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails;
- }
- export interface AwsEventsEndpointRoutingConfigFailoverConfigPrimaryDetails {
- /**
- * The Amazon Resource Name (ARN) of the health check used by the endpoint to determine whether failover is triggered.
- */
- HealthCheck?: NonEmptyString;
- }
- export interface AwsEventsEndpointRoutingConfigFailoverConfigSecondaryDetails {
- /**
- * Defines the secondary Region.
- */
- Route?: NonEmptyString;
- }
- export interface AwsEventsEventbusDetails {
- /**
- * The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
- */
- Arn?: NonEmptyString;
- /**
- * The name of the event bus.
- */
- Name?: NonEmptyString;
- /**
- * The policy that enables the external account to send events to your account.
- */
- Policy?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesCloudTrailDetails {
- /**
- * Specifies whether CloudTrail is activated as a data source for the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesDetails {
- /**
- * An object that contains information on the status of CloudTrail as a data source for the detector.
- */
- CloudTrail?: AwsGuardDutyDetectorDataSourcesCloudTrailDetails;
- /**
- * An object that contains information on the status of DNS logs as a data source for the detector.
- */
- DnsLogs?: AwsGuardDutyDetectorDataSourcesDnsLogsDetails;
- /**
- * An object that contains information on the status of VPC Flow Logs as a data source for the detector.
- */
- FlowLogs?: AwsGuardDutyDetectorDataSourcesFlowLogsDetails;
- /**
- * An object that contains information on the status of Kubernetes data sources for the detector.
- */
- Kubernetes?: AwsGuardDutyDetectorDataSourcesKubernetesDetails;
- /**
- * An object that contains information on the status of Malware Protection as a data source for the detector.
- */
- MalwareProtection?: AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails;
- /**
- * An object that contains information on the status of S3 Data event logs as a data source for the detector.
- */
- S3Logs?: AwsGuardDutyDetectorDataSourcesS3LogsDetails;
- }
- export interface AwsGuardDutyDetectorDataSourcesDnsLogsDetails {
- /**
- * Describes whether DNS logs is enabled as a data source for the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesFlowLogsDetails {
- /**
- * Describes whether VPC Flow Logs are activated as a data source for the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails {
- /**
- * Describes whether Kubernetes audit logs are activated as a data source for the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesKubernetesDetails {
- /**
- * Describes whether Kubernetes audit logs are activated as a data source for the detector.
- */
- AuditLogs?: AwsGuardDutyDetectorDataSourcesKubernetesAuditLogsDetails;
- }
- export interface AwsGuardDutyDetectorDataSourcesMalwareProtectionDetails {
- /**
- * Describes the configuration of Malware Protection for EC2 instances with findings.
- */
- ScanEc2InstanceWithFindings?: AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails;
- /**
- * The GuardDuty Malware Protection service role.
- */
- ServiceRole?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsDetails {
- /**
- * Describes the configuration of scanning EBS volumes (Malware Protection) as a data source.
- */
- EbsVolumes?: AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails;
- }
- export interface AwsGuardDutyDetectorDataSourcesMalwareProtectionScanEc2InstanceWithFindingsEbsVolumesDetails {
- /**
- * Specifies the reason why scanning EBS volumes (Malware Protection) isn’t activated as a data source.
- */
- Reason?: NonEmptyString;
- /**
- * Describes whether scanning EBS volumes is activated as a data source for the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDataSourcesS3LogsDetails {
- /**
- * A value that describes whether S3 data event logs are automatically enabled for new members of an organization.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorDetails {
- /**
- * Describes which data sources are activated for the detector.
- */
- DataSources?: AwsGuardDutyDetectorDataSourcesDetails;
- /**
- * Describes which features are activated for the detector.
- */
- Features?: AwsGuardDutyDetectorFeaturesList;
- /**
- * The publishing frequency of the finding.
- */
- FindingPublishingFrequency?: NonEmptyString;
- /**
- * The GuardDuty service role.
- */
- ServiceRole?: NonEmptyString;
- /**
- * The activation status of the detector.
- */
- Status?: NonEmptyString;
- }
- export interface AwsGuardDutyDetectorFeaturesDetails {
- /**
- * Indicates the name of the feature that is activated for the detector.
- */
- Name?: NonEmptyString;
- /**
- * Indicates the status of the feature that is activated for the detector.
- */
- Status?: NonEmptyString;
- }
- export type AwsGuardDutyDetectorFeaturesList = AwsGuardDutyDetectorFeaturesDetails[];
- export interface AwsIamAccessKeyDetails {
- /**
- * The user associated with the IAM access key related to a finding. The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.
- */
- UserName?: NonEmptyString;
- /**
- * The status of the IAM access key related to a finding.
- */
- Status?: AwsIamAccessKeyStatus;
- /**
- * Indicates when the IAM access key was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: NonEmptyString;
- /**
- * The ID of the principal associated with an access key.
- */
- PrincipalId?: NonEmptyString;
- /**
- * The type of principal associated with an access key.
- */
- PrincipalType?: NonEmptyString;
- /**
- * The name of the principal.
- */
- PrincipalName?: NonEmptyString;
- /**
- * The Amazon Web Services account ID of the account for the key.
- */
- AccountId?: NonEmptyString;
- /**
- * The identifier of the access key.
- */
- AccessKeyId?: NonEmptyString;
- /**
- * Information about the session that the key was used for.
- */
- SessionContext?: AwsIamAccessKeySessionContext;
- }
- export interface AwsIamAccessKeySessionContext {
- /**
- * Attributes of the session that the key was used for.
- */
- Attributes?: AwsIamAccessKeySessionContextAttributes;
- /**
- * Information about the entity that created the session.
- */
- SessionIssuer?: AwsIamAccessKeySessionContextSessionIssuer;
- }
- export interface AwsIamAccessKeySessionContextAttributes {
- /**
- * Indicates whether the session used multi-factor authentication (MFA).
- */
- MfaAuthenticated?: Boolean;
- /**
- * Indicates when the session was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreationDate?: NonEmptyString;
- }
- export interface AwsIamAccessKeySessionContextSessionIssuer {
- /**
- * The type of principal (user, role, or group) that created the session.
- */
- Type?: NonEmptyString;
- /**
- * The principal ID of the principal (user, role, or group) that created the session.
- */
- PrincipalId?: NonEmptyString;
- /**
- * The ARN of the session.
- */
- Arn?: NonEmptyString;
- /**
- * The identifier of the Amazon Web Services account that created the session.
- */
- AccountId?: NonEmptyString;
- /**
- * The name of the principal that created the session.
- */
- UserName?: NonEmptyString;
- }
- export type AwsIamAccessKeyStatus = "Active"|"Inactive"|string;
- export interface AwsIamAttachedManagedPolicy {
- /**
- * The name of the policy.
- */
- PolicyName?: NonEmptyString;
- /**
- * The ARN of the policy.
- */
- PolicyArn?: NonEmptyString;
- }
- export type AwsIamAttachedManagedPolicyList = AwsIamAttachedManagedPolicy[];
- export interface AwsIamGroupDetails {
- /**
- * A list of the managed policies that are attached to the IAM group.
- */
- AttachedManagedPolicies?: AwsIamAttachedManagedPolicyList;
- /**
- * Indicates when the IAM group was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * The identifier of the IAM group.
- */
- GroupId?: NonEmptyString;
- /**
- * The name of the IAM group.
- */
- GroupName?: NonEmptyString;
- /**
- * The list of inline policies that are embedded in the group.
- */
- GroupPolicyList?: AwsIamGroupPolicyList;
- /**
- * The path to the group.
- */
- Path?: NonEmptyString;
- }
- export interface AwsIamGroupPolicy {
- /**
- * The name of the policy.
- */
- PolicyName?: NonEmptyString;
- }
- export type AwsIamGroupPolicyList = AwsIamGroupPolicy[];
- export interface AwsIamInstanceProfile {
- /**
- * The ARN of the instance profile.
- */
- Arn?: NonEmptyString;
- /**
- * Indicates when the instance profile was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * The identifier of the instance profile.
- */
- InstanceProfileId?: NonEmptyString;
- /**
- * The name of the instance profile.
- */
- InstanceProfileName?: NonEmptyString;
- /**
- * The path to the instance profile.
- */
- Path?: NonEmptyString;
- /**
- * The roles associated with the instance profile.
- */
- Roles?: AwsIamInstanceProfileRoles;
- }
- export type AwsIamInstanceProfileList = AwsIamInstanceProfile[];
- export interface AwsIamInstanceProfileRole {
- /**
- * The ARN of the role.
- */
- Arn?: NonEmptyString;
- /**
- * The policy that grants an entity permission to assume the role.
- */
- AssumeRolePolicyDocument?: AwsIamRoleAssumeRolePolicyDocument;
- /**
- * Indicates when the role was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * The path to the role.
- */
- Path?: NonEmptyString;
- /**
- * The identifier of the role.
- */
- RoleId?: NonEmptyString;
- /**
- * The name of the role.
- */
- RoleName?: NonEmptyString;
- }
- export type AwsIamInstanceProfileRoles = AwsIamInstanceProfileRole[];
- export interface AwsIamPermissionsBoundary {
- /**
- * The ARN of the policy used to set the permissions boundary.
- */
- PermissionsBoundaryArn?: NonEmptyString;
- /**
- * The usage type for the permissions boundary.
- */
- PermissionsBoundaryType?: NonEmptyString;
- }
- export interface AwsIamPolicyDetails {
- /**
- * The number of users, groups, and roles that the policy is attached to.
- */
- AttachmentCount?: Integer;
- /**
- * When the policy was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * The identifier of the default version of the policy.
- */
- DefaultVersionId?: NonEmptyString;
- /**
- * A description of the policy.
- */
- Description?: NonEmptyString;
- /**
- * Whether the policy can be attached to a user, group, or role.
- */
- IsAttachable?: Boolean;
- /**
- * The path to the policy.
- */
- Path?: NonEmptyString;
- /**
- * The number of users and roles that use the policy to set the permissions boundary.
- */
- PermissionsBoundaryUsageCount?: Integer;
- /**
- * The unique identifier of the policy.
- */
- PolicyId?: NonEmptyString;
- /**
- * The name of the policy.
- */
- PolicyName?: NonEmptyString;
- /**
- * List of versions of the policy.
- */
- PolicyVersionList?: AwsIamPolicyVersionList;
- /**
- * When the policy was most recently updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdateDate?: NonEmptyString;
- }
- export interface AwsIamPolicyVersion {
- /**
- * The identifier of the policy version.
- */
- VersionId?: NonEmptyString;
- /**
- * Whether the version is the default version.
- */
- IsDefaultVersion?: Boolean;
- /**
- * Indicates when the version was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- }
- export type AwsIamPolicyVersionList = AwsIamPolicyVersion[];
- export type AwsIamRoleAssumeRolePolicyDocument = string;
- export interface AwsIamRoleDetails {
- /**
- * The trust policy that grants permission to assume the role.
- */
- AssumeRolePolicyDocument?: AwsIamRoleAssumeRolePolicyDocument;
- /**
- * The list of the managed policies that are attached to the role.
- */
- AttachedManagedPolicies?: AwsIamAttachedManagedPolicyList;
- /**
- * Indicates when the role was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * The list of instance profiles that contain this role.
- */
- InstanceProfileList?: AwsIamInstanceProfileList;
- PermissionsBoundary?: AwsIamPermissionsBoundary;
- /**
- * The stable and unique string identifying the role.
- */
- RoleId?: NonEmptyString;
- /**
- * The friendly name that identifies the role.
- */
- RoleName?: NonEmptyString;
- /**
- * The list of inline policies that are embedded in the role.
- */
- RolePolicyList?: AwsIamRolePolicyList;
- /**
- * The maximum session duration (in seconds) that you want to set for the specified role.
- */
- MaxSessionDuration?: Integer;
- /**
- * The path to the role.
- */
- Path?: NonEmptyString;
- }
- export interface AwsIamRolePolicy {
- /**
- * The name of the policy.
- */
- PolicyName?: NonEmptyString;
- }
- export type AwsIamRolePolicyList = AwsIamRolePolicy[];
- export interface AwsIamUserDetails {
- /**
- * A list of the managed policies that are attached to the user.
- */
- AttachedManagedPolicies?: AwsIamAttachedManagedPolicyList;
- /**
- * Indicates when the user was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreateDate?: NonEmptyString;
- /**
- * A list of IAM groups that the user belongs to.
- */
- GroupList?: StringList;
- /**
- * The path to the user.
- */
- Path?: NonEmptyString;
- /**
- * The permissions boundary for the user.
- */
- PermissionsBoundary?: AwsIamPermissionsBoundary;
- /**
- * The unique identifier for the user.
- */
- UserId?: NonEmptyString;
- /**
- * The name of the user.
- */
- UserName?: NonEmptyString;
- /**
- * The list of inline policies that are embedded in the user.
- */
- UserPolicyList?: AwsIamUserPolicyList;
- }
- export interface AwsIamUserPolicy {
- /**
- * The name of the policy.
- */
- PolicyName?: NonEmptyString;
- }
- export type AwsIamUserPolicyList = AwsIamUserPolicy[];
- export interface AwsKinesisStreamDetails {
- /**
- * The name of the Kinesis stream. If you don't specify a name, CloudFront generates a unique physical ID and uses that ID for the stream name.
- */
- Name?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the Kinesis data stream.
- */
- Arn?: NonEmptyString;
- /**
- * When specified, enables or updates server-side encryption using an KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
- */
- StreamEncryption?: AwsKinesisStreamStreamEncryptionDetails;
- /**
- * The number of shards that the stream uses.
- */
- ShardCount?: Integer;
- /**
- * The number of hours for the data records that are stored in shards to remain accessible.
- */
- RetentionPeriodHours?: Integer;
- }
- export interface AwsKinesisStreamStreamEncryptionDetails {
- /**
- * The encryption type to use.
- */
- EncryptionType?: NonEmptyString;
- /**
- * The globally unique identifier for the customer-managed KMS key to use for encryption.
- */
- KeyId?: NonEmptyString;
- }
- export interface AwsKmsKeyDetails {
- /**
- * The twelve-digit account ID of the Amazon Web Services account that owns the KMS key.
- */
- AWSAccountId?: NonEmptyString;
- /**
- * Indicates when the KMS key was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreationDate?: Double;
- /**
- * The globally unique identifier for the KMS key.
- */
- KeyId?: NonEmptyString;
- /**
- * The manager of the KMS key. KMS keys in your Amazon Web Services account are either customer managed or Amazon Web Services managed.
- */
- KeyManager?: NonEmptyString;
- /**
- * The state of the KMS key. Valid values are as follows: Disabled Enabled PendingDeletion PendingImport Unavailable
- */
- KeyState?: NonEmptyString;
- /**
- * The source of the KMS key material. When this value is AWS_KMS, KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the KMS key lacks key material. When this value is AWS_CLOUDHSM, the key material was created in the CloudHSM cluster associated with a custom key store.
- */
- Origin?: NonEmptyString;
- /**
- * A description of the KMS key.
- */
- Description?: NonEmptyString;
- /**
- * Whether the key has key rotation enabled.
- */
- KeyRotationStatus?: Boolean;
- }
- export interface AwsLambdaFunctionCode {
- /**
- * An Amazon S3 bucket in the same Amazon Web Services Region as your function. The bucket can be in a different Amazon Web Services account.
- */
- S3Bucket?: NonEmptyString;
- /**
- * The Amazon S3 key of the deployment package.
- */
- S3Key?: NonEmptyString;
- /**
- * For versioned objects, the version of the deployment package object to use.
- */
- S3ObjectVersion?: NonEmptyString;
- /**
- * The base64-encoded contents of the deployment package. Amazon Web Services SDK and Amazon Web Services CLI clients handle the encoding for you.
- */
- ZipFile?: NonEmptyString;
- }
- export interface AwsLambdaFunctionDeadLetterConfig {
- /**
- * The ARN of an SQS queue or SNS topic.
- */
- TargetArn?: NonEmptyString;
- }
- export interface AwsLambdaFunctionDetails {
- /**
- * An AwsLambdaFunctionCode object.
- */
- Code?: AwsLambdaFunctionCode;
- /**
- * The SHA256 hash of the function's deployment package.
- */
- CodeSha256?: NonEmptyString;
- /**
- * The function's dead letter queue.
- */
- DeadLetterConfig?: AwsLambdaFunctionDeadLetterConfig;
- /**
- * The function's environment variables.
- */
- Environment?: AwsLambdaFunctionEnvironment;
- /**
- * The name of the function.
- */
- FunctionName?: NonEmptyString;
- /**
- * The function that Lambda calls to begin executing your function.
- */
- Handler?: NonEmptyString;
- /**
- * The KMS key that is used to encrypt the function's environment variables. This key is only returned if you've configured a customer managed customer managed key.
- */
- KmsKeyArn?: NonEmptyString;
- /**
- * Indicates when the function was last updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastModified?: NonEmptyString;
- /**
- * The function's layers.
- */
- Layers?: AwsLambdaFunctionLayerList;
- /**
- * For Lambda@Edge functions, the ARN of the master function.
- */
- MasterArn?: NonEmptyString;
- /**
- * The memory that is allocated to the function.
- */
- MemorySize?: Integer;
- /**
- * The latest updated revision of the function or alias.
- */
- RevisionId?: NonEmptyString;
- /**
- * The function's execution role.
- */
- Role?: NonEmptyString;
- /**
- * The runtime environment for the Lambda function.
- */
- Runtime?: NonEmptyString;
- /**
- * The amount of time that Lambda allows a function to run before stopping it.
- */
- Timeout?: Integer;
- /**
- * The function's X-Ray tracing configuration.
- */
- TracingConfig?: AwsLambdaFunctionTracingConfig;
- /**
- * The function's networking configuration.
- */
- VpcConfig?: AwsLambdaFunctionVpcConfig;
- /**
- * The version of the Lambda function.
- */
- Version?: NonEmptyString;
- /**
- * The instruction set architecture that the function uses. Valid values are x86_64 or arm64.
- */
- Architectures?: NonEmptyStringList;
- /**
- * The type of deployment package that's used to deploy the function code to Lambda. Set to Image for a container image and Zip for a .zip file archive.
- */
- PackageType?: NonEmptyString;
- }
- export interface AwsLambdaFunctionEnvironment {
- /**
- * Environment variable key-value pairs.
- */
- Variables?: FieldMap;
- /**
- * An AwsLambdaFunctionEnvironmentError object.
- */
- Error?: AwsLambdaFunctionEnvironmentError;
- }
- export interface AwsLambdaFunctionEnvironmentError {
- /**
- * The error code.
- */
- ErrorCode?: NonEmptyString;
- /**
- * The error message.
- */
- Message?: NonEmptyString;
- }
- export interface AwsLambdaFunctionLayer {
- /**
- * The ARN of the function layer.
- */
- Arn?: NonEmptyString;
- /**
- * The size of the layer archive in bytes.
- */
- CodeSize?: Integer;
- }
- export type AwsLambdaFunctionLayerList = AwsLambdaFunctionLayer[];
- export interface AwsLambdaFunctionTracingConfig {
- /**
- * The tracing mode.
- */
- Mode?: NonEmptyString;
- }
- export interface AwsLambdaFunctionVpcConfig {
- /**
- * A list of VPC security groups IDs.
- */
- SecurityGroupIds?: NonEmptyStringList;
- /**
- * A list of VPC subnet IDs.
- */
- SubnetIds?: NonEmptyStringList;
- /**
- * The ID of the VPC.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsLambdaLayerVersionDetails {
- /**
- * The version number.
- */
- Version?: AwsLambdaLayerVersionNumber;
- /**
- * The layer's compatible function runtimes. The following list includes deprecated runtimes. For more information, see Runtime deprecation policy in the Lambda Developer Guide. Array Members: Maximum number of 5 items. Valid Values: nodejs | nodejs4.3 | nodejs6.10 | nodejs8.10 | nodejs10.x | nodejs12.x | nodejs14.x | nodejs16.x | java8 | java8.al2 | java11 | python2.7 | python3.6 | python3.7 | python3.8 | python3.9 | dotnetcore1.0 | dotnetcore2.0 | dotnetcore2.1 | dotnetcore3.1 | dotnet6 | nodejs4.3-edge | go1.x | ruby2.5 | ruby2.7 | provided | provided.al2 | nodejs18.x | python3.10 | java17 | ruby3.2 | python3.11 | nodejs20.x | provided.al2023 | python3.12 | java21
- */
- CompatibleRuntimes?: NonEmptyStringList;
- /**
- * Indicates when the version was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedDate?: NonEmptyString;
- }
- export type AwsLambdaLayerVersionNumber = number;
- export interface AwsMountPoint {
- /**
- * The name of the volume to mount. Must be a volume name referenced in the name parameter of task definition volume.
- */
- SourceVolume?: NonEmptyString;
- /**
- * The path on the container to mount the host volume at.
- */
- ContainerPath?: NonEmptyString;
- }
- export type AwsMountPointList = AwsMountPoint[];
- export interface AwsMskClusterClusterInfoClientAuthenticationDetails {
- /**
- * Provides details for client authentication using SASL.
- */
- Sasl?: AwsMskClusterClusterInfoClientAuthenticationSaslDetails;
- /**
- * Provides details for allowing no client authentication.
- */
- Unauthenticated?: AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails;
- /**
- * Provides details for client authentication using TLS.
- */
- Tls?: AwsMskClusterClusterInfoClientAuthenticationTlsDetails;
- }
- export interface AwsMskClusterClusterInfoClientAuthenticationSaslDetails {
- /**
- * Provides details for SASL client authentication using IAM.
- */
- Iam?: AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails;
- /**
- * Details for SASL client authentication using SCRAM.
- */
- Scram?: AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails;
- }
- export interface AwsMskClusterClusterInfoClientAuthenticationSaslIamDetails {
- /**
- * Indicates whether SASL/IAM authentication is enabled or not.
- */
- Enabled?: Boolean;
- }
- export interface AwsMskClusterClusterInfoClientAuthenticationSaslScramDetails {
- /**
- * Indicates whether SASL/SCRAM authentication is enabled or not.
- */
- Enabled?: Boolean;
- }
- export interface AwsMskClusterClusterInfoClientAuthenticationTlsDetails {
- /**
- * List of Amazon Web Services Private CA Amazon Resource Names (ARNs). Amazon Web Services Private CA enables creation of private certificate authority (CA) hierarchies, including root and subordinate CAs, without the investment and maintenance costs of operating an on-premises CA.
- */
- CertificateAuthorityArnList?: StringList;
- /**
- * Indicates whether TLS authentication is enabled or not.
- */
- Enabled?: Boolean;
- }
- export interface AwsMskClusterClusterInfoClientAuthenticationUnauthenticatedDetails {
- /**
- * Indicates whether unauthenticated is allowed or not.
- */
- Enabled?: Boolean;
- }
- export interface AwsMskClusterClusterInfoDetails {
- /**
- * Includes encryption-related information, such as the KMS key used for encrypting data at rest and whether you want Amazon MSK to encrypt your data in transit.
- */
- EncryptionInfo?: AwsMskClusterClusterInfoEncryptionInfoDetails;
- /**
- * The current version of the cluster.
- */
- CurrentVersion?: NonEmptyString;
- /**
- * The number of broker nodes in the cluster.
- */
- NumberOfBrokerNodes?: Integer;
- /**
- * The name of the cluster.
- */
- ClusterName?: NonEmptyString;
- /**
- * Provides information for different modes of client authentication.
- */
- ClientAuthentication?: AwsMskClusterClusterInfoClientAuthenticationDetails;
- /**
- * Specifies the level of monitoring for the cluster.
- */
- EnhancedMonitoring?: NonEmptyString;
- }
- export interface AwsMskClusterClusterInfoEncryptionInfoDetails {
- /**
- * The settings for encrypting data in transit.
- */
- EncryptionInTransit?: AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails;
- /**
- * The data-volume encryption details. You can't update encryption at rest settings for existing clusters.
- */
- EncryptionAtRest?: AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails;
- }
- export interface AwsMskClusterClusterInfoEncryptionInfoEncryptionAtRestDetails {
- /**
- * The Amazon Resource Name (ARN) of the KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
- */
- DataVolumeKMSKeyId?: NonEmptyString;
- }
- export interface AwsMskClusterClusterInfoEncryptionInfoEncryptionInTransitDetails {
- /**
- * When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plain text. The default value is true.
- */
- InCluster?: Boolean;
- /**
- * Indicates the encryption setting for data in transit between clients and brokers.
- */
- ClientBroker?: NonEmptyString;
- }
- export interface AwsMskClusterDetails {
- /**
- * Provides information about a cluster.
- */
- ClusterInfo?: AwsMskClusterClusterInfoDetails;
- }
- export interface AwsNetworkFirewallFirewallDetails {
- /**
- * Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.
- */
- DeleteProtection?: Boolean;
- /**
- * A description of the firewall.
- */
- Description?: NonEmptyString;
- /**
- * The ARN of the firewall.
- */
- FirewallArn?: NonEmptyString;
- /**
- * The identifier of the firewall.
- */
- FirewallId?: NonEmptyString;
- /**
- * A descriptive name of the firewall.
- */
- FirewallName?: NonEmptyString;
- /**
- * The ARN of the firewall policy.
- */
- FirewallPolicyArn?: NonEmptyString;
- /**
- * Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.
- */
- FirewallPolicyChangeProtection?: Boolean;
- /**
- * Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.
- */
- SubnetChangeProtection?: Boolean;
- /**
- * The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.
- */
- SubnetMappings?: AwsNetworkFirewallFirewallSubnetMappingsList;
- /**
- * The identifier of the VPC where the firewall is used.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsNetworkFirewallFirewallPolicyDetails {
- /**
- * The firewall policy configuration.
- */
- FirewallPolicy?: FirewallPolicyDetails;
- /**
- * The ARN of the firewall policy.
- */
- FirewallPolicyArn?: NonEmptyString;
- /**
- * The identifier of the firewall policy.
- */
- FirewallPolicyId?: NonEmptyString;
- /**
- * The name of the firewall policy.
- */
- FirewallPolicyName?: NonEmptyString;
- /**
- * A description of the firewall policy.
- */
- Description?: NonEmptyString;
- }
- export interface AwsNetworkFirewallFirewallSubnetMappingsDetails {
- /**
- * The identifier of the subnet
- */
- SubnetId?: NonEmptyString;
- }
- export type AwsNetworkFirewallFirewallSubnetMappingsList = AwsNetworkFirewallFirewallSubnetMappingsDetails[];
- export interface AwsNetworkFirewallRuleGroupDetails {
- /**
- * The maximum number of operating resources that this rule group can use.
- */
- Capacity?: Integer;
- /**
- * A description of the rule group.
- */
- Description?: NonEmptyString;
- /**
- * Details about the rule group.
- */
- RuleGroup?: RuleGroupDetails;
- /**
- * The ARN of the rule group.
- */
- RuleGroupArn?: NonEmptyString;
- /**
- * The identifier of the rule group.
- */
- RuleGroupId?: NonEmptyString;
- /**
- * The descriptive name of the rule group.
- */
- RuleGroupName?: NonEmptyString;
- /**
- * The type of rule group. A rule group can be stateful or stateless.
- */
- Type?: NonEmptyString;
- }
- export interface AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails {
- /**
- * Enables fine-grained access control.
- */
- Enabled?: Boolean;
- /**
- * Enables the internal user database.
- */
- InternalUserDatabaseEnabled?: Boolean;
- /**
- * Specifies information about the master user of the domain.
- */
- MasterUserOptions?: AwsOpenSearchServiceDomainMasterUserOptionsDetails;
- }
- export interface AwsOpenSearchServiceDomainClusterConfigDetails {
- /**
- * The number of data nodes to use in the OpenSearch domain.
- */
- InstanceCount?: Integer;
- /**
- * Whether UltraWarm is enabled.
- */
- WarmEnabled?: Boolean;
- /**
- * The number of UltraWarm instances.
- */
- WarmCount?: Integer;
- /**
- * Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
- */
- DedicatedMasterEnabled?: Boolean;
- /**
- * Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
- */
- ZoneAwarenessConfig?: AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails;
- /**
- * The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
- */
- DedicatedMasterCount?: Integer;
- /**
- * The instance type for your data nodes. For a list of valid values, see Supported instance types in Amazon OpenSearch Service in the Amazon OpenSearch Service Developer Guide.
- */
- InstanceType?: NonEmptyString;
- /**
- * The type of UltraWarm instance.
- */
- WarmType?: NonEmptyString;
- /**
- * Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
- */
- ZoneAwarenessEnabled?: Boolean;
- /**
- * The hardware configuration of the computer that hosts the dedicated master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
- */
- DedicatedMasterType?: NonEmptyString;
- }
- export interface AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails {
- /**
- * The number of Availability Zones that the domain uses. Valid values are 2 or 3. The default is 2.
- */
- AvailabilityZoneCount?: Integer;
- }
- export interface AwsOpenSearchServiceDomainDetails {
- /**
- * The ARN of the OpenSearch Service domain.
- */
- Arn?: NonEmptyString;
- /**
- * IAM policy document that specifies the access policies for the OpenSearch Service domain.
- */
- AccessPolicies?: NonEmptyString;
- /**
- * The name of the endpoint.
- */
- DomainName?: NonEmptyString;
- /**
- * The identifier of the domain.
- */
- Id?: NonEmptyString;
- /**
- * The domain endpoint.
- */
- DomainEndpoint?: NonEmptyString;
- /**
- * The version of the domain engine.
- */
- EngineVersion?: NonEmptyString;
- /**
- * Details about the configuration for encryption at rest.
- */
- EncryptionAtRestOptions?: AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails;
- /**
- * Details about the configuration for node-to-node encryption.
- */
- NodeToNodeEncryptionOptions?: AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails;
- /**
- * Information about the status of a domain relative to the latest service software.
- */
- ServiceSoftwareOptions?: AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails;
- /**
- * Details about the configuration of an OpenSearch cluster.
- */
- ClusterConfig?: AwsOpenSearchServiceDomainClusterConfigDetails;
- /**
- * Additional options for the domain endpoint.
- */
- DomainEndpointOptions?: AwsOpenSearchServiceDomainDomainEndpointOptionsDetails;
- /**
- * Information that OpenSearch Service derives based on VPCOptions for the domain.
- */
- VpcOptions?: AwsOpenSearchServiceDomainVpcOptionsDetails;
- /**
- * Configures the CloudWatch Logs to publish for the OpenSearch domain.
- */
- LogPublishingOptions?: AwsOpenSearchServiceDomainLogPublishingOptionsDetails;
- /**
- * The domain endpoints. Used if the OpenSearch domain resides in a VPC. This is a map of key-value pairs. The key is always vpc. The value is the endpoint.
- */
- DomainEndpoints?: FieldMap;
- /**
- * Specifies options for fine-grained access control.
- */
- AdvancedSecurityOptions?: AwsOpenSearchServiceDomainAdvancedSecurityOptionsDetails;
- }
- export interface AwsOpenSearchServiceDomainDomainEndpointOptionsDetails {
- /**
- * The ARN for the security certificate. The certificate is managed in ACM.
- */
- CustomEndpointCertificateArn?: NonEmptyString;
- /**
- * Whether to enable a custom endpoint for the domain.
- */
- CustomEndpointEnabled?: Boolean;
- /**
- * Whether to require that all traffic to the domain arrive over HTTPS.
- */
- EnforceHTTPS?: Boolean;
- /**
- * The fully qualified URL for the custom endpoint.
- */
- CustomEndpoint?: NonEmptyString;
- /**
- * The TLS security policy to apply to the HTTPS endpoint of the OpenSearch domain.
- */
- TLSSecurityPolicy?: NonEmptyString;
- }
- export interface AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails {
- /**
- * Whether encryption at rest is enabled.
- */
- Enabled?: Boolean;
- /**
- * The KMS key ID.
- */
- KmsKeyId?: NonEmptyString;
- }
- export interface AwsOpenSearchServiceDomainLogPublishingOption {
- /**
- * The ARN of the CloudWatch Logs group to publish the logs to.
- */
- CloudWatchLogsLogGroupArn?: NonEmptyString;
- /**
- * Whether the log publishing is enabled.
- */
- Enabled?: Boolean;
- }
- export interface AwsOpenSearchServiceDomainLogPublishingOptionsDetails {
- /**
- * Configures the OpenSearch index logs publishing.
- */
- IndexSlowLogs?: AwsOpenSearchServiceDomainLogPublishingOption;
- /**
- * Configures the OpenSearch search slow log publishing.
- */
- SearchSlowLogs?: AwsOpenSearchServiceDomainLogPublishingOption;
- /**
- * Configures the OpenSearch audit logs publishing.
- */
- AuditLogs?: AwsOpenSearchServiceDomainLogPublishingOption;
- }
- export interface AwsOpenSearchServiceDomainMasterUserOptionsDetails {
- /**
- * The Amazon Resource Name (ARN) for the master user.
- */
- MasterUserArn?: NonEmptyString;
- /**
- * The username for the master user.
- */
- MasterUserName?: NonEmptyString;
- /**
- * The password for the master user.
- */
- MasterUserPassword?: NonEmptyString;
- }
- export interface AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails {
- /**
- * Whether node-to-node encryption is enabled.
- */
- Enabled?: Boolean;
- }
- export interface AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails {
- /**
- * The epoch time when the deployment window closes for required updates. After this time, OpenSearch Service schedules the software upgrade automatically.
- */
- AutomatedUpdateDate?: NonEmptyString;
- /**
- * Whether a request to update the domain can be canceled.
- */
- Cancellable?: Boolean;
- /**
- * The version of the service software that is currently installed on the domain.
- */
- CurrentVersion?: NonEmptyString;
- /**
- * A more detailed description of the service software status.
- */
- Description?: NonEmptyString;
- /**
- * The most recent version of the service software.
- */
- NewVersion?: NonEmptyString;
- /**
- * Whether a service software update is available for the domain.
- */
- UpdateAvailable?: Boolean;
- /**
- * The status of the service software update. Valid values are as follows: COMPLETED ELIGIBLE IN_PROGRESS NOT_ELIGIBLE PENDING_UPDATE
- */
- UpdateStatus?: NonEmptyString;
- /**
- * Whether the service software update is optional.
- */
- OptionalDeployment?: Boolean;
- }
- export interface AwsOpenSearchServiceDomainVpcOptionsDetails {
- /**
- * The list of security group IDs that are associated with the VPC endpoints for the domain.
- */
- SecurityGroupIds?: NonEmptyStringList;
- /**
- * A list of subnet IDs that are associated with the VPC endpoints for the domain.
- */
- SubnetIds?: NonEmptyStringList;
- }
- export interface AwsRdsDbClusterAssociatedRole {
- /**
- * The ARN of the IAM role.
- */
- RoleArn?: NonEmptyString;
- /**
- * The status of the association between the IAM role and the DB cluster. Valid values are as follows: ACTIVE INVALID PENDING
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbClusterAssociatedRoles = AwsRdsDbClusterAssociatedRole[];
- export interface AwsRdsDbClusterDetails {
- /**
- * For all database engines except Aurora, specifies the allocated storage size in gibibytes (GiB).
- */
- AllocatedStorage?: Integer;
- /**
- * A list of Availability Zones (AZs) where instances in the DB cluster can be created.
- */
- AvailabilityZones?: StringList;
- /**
- * The number of days for which automated backups are retained.
- */
- BackupRetentionPeriod?: Integer;
- /**
- * The name of the database.
- */
- DatabaseName?: NonEmptyString;
- /**
- * The current status of this DB cluster.
- */
- Status?: NonEmptyString;
- /**
- * The connection endpoint for the primary instance of the DB cluster.
- */
- Endpoint?: NonEmptyString;
- /**
- * The reader endpoint for the DB cluster.
- */
- ReaderEndpoint?: NonEmptyString;
- /**
- * A list of custom endpoints for the DB cluster.
- */
- CustomEndpoints?: StringList;
- /**
- * Whether the DB cluster has instances in multiple Availability Zones.
- */
- MultiAz?: Boolean;
- /**
- * The name of the database engine to use for this DB cluster. Valid values are as follows: aurora aurora-mysql aurora-postgresql
- */
- Engine?: NonEmptyString;
- /**
- * The version number of the database engine to use.
- */
- EngineVersion?: NonEmptyString;
- /**
- * The port number on which the DB instances in the DB cluster accept connections.
- */
- Port?: Integer;
- /**
- * The name of the master user for the DB cluster.
- */
- MasterUsername?: NonEmptyString;
- /**
- * The range of time each day when automated backups are created, if automated backups are enabled. Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
- */
- PreferredBackupWindow?: NonEmptyString;
- /**
- * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Uses the format <day>:HH:MM-<day>:HH:MM. For the day values, use mon|tue|wed|thu|fri|sat|sun. For example, sun:09:32-sun:10:02.
- */
- PreferredMaintenanceWindow?: NonEmptyString;
- /**
- * The identifiers of the read replicas that are associated with this DB cluster.
- */
- ReadReplicaIdentifiers?: StringList;
- /**
- * A list of VPC security groups that the DB cluster belongs to.
- */
- VpcSecurityGroups?: AwsRdsDbInstanceVpcSecurityGroups;
- /**
- * Specifies the identifier that Amazon Route 53 assigns when you create a hosted zone.
- */
- HostedZoneId?: NonEmptyString;
- /**
- * Whether the DB cluster is encrypted.
- */
- StorageEncrypted?: Boolean;
- /**
- * The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The identifier of the DB cluster. The identifier must be unique within each Amazon Web Services Region and is immutable.
- */
- DbClusterResourceId?: NonEmptyString;
- /**
- * A list of the IAM roles that are associated with the DB cluster.
- */
- AssociatedRoles?: AwsRdsDbClusterAssociatedRoles;
- /**
- * Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ClusterCreateTime?: NonEmptyString;
- /**
- * A list of log types that this DB cluster is configured to export to CloudWatch Logs.
- */
- EnabledCloudWatchLogsExports?: StringList;
- /**
- * The database engine mode of the DB cluster.Valid values are as follows: global multimaster parallelquery provisioned serverless
- */
- EngineMode?: NonEmptyString;
- /**
- * Whether the DB cluster has deletion protection enabled.
- */
- DeletionProtection?: Boolean;
- /**
- * Whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled.
- */
- HttpEndpointEnabled?: Boolean;
- /**
- * The status of the database activity stream. Valid values are as follows: started starting stopped stopping
- */
- ActivityStreamStatus?: NonEmptyString;
- /**
- * Whether tags are copied from the DB cluster to snapshots of the DB cluster.
- */
- CopyTagsToSnapshot?: Boolean;
- /**
- * Whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.
- */
- CrossAccountClone?: Boolean;
- /**
- * The Active Directory domain membership records that are associated with the DB cluster.
- */
- DomainMemberships?: AwsRdsDbDomainMemberships;
- /**
- * The name of the DB cluster parameter group for the DB cluster.
- */
- DbClusterParameterGroup?: NonEmptyString;
- /**
- * The subnet group that is associated with the DB cluster, including the name, description, and subnets in the subnet group.
- */
- DbSubnetGroup?: NonEmptyString;
- /**
- * The list of option group memberships for this DB cluster.
- */
- DbClusterOptionGroupMemberships?: AwsRdsDbClusterOptionGroupMemberships;
- /**
- * The DB cluster identifier that the user assigned to the cluster. This identifier is the unique key that identifies a DB cluster.
- */
- DbClusterIdentifier?: NonEmptyString;
- /**
- * The list of instances that make up the DB cluster.
- */
- DbClusterMembers?: AwsRdsDbClusterMembers;
- /**
- * Whether the mapping of IAM accounts to database accounts is enabled.
- */
- IamDatabaseAuthenticationEnabled?: Boolean;
- /**
- * Indicates if minor version upgrades are automatically applied to the cluster.
- */
- AutoMinorVersionUpgrade?: Boolean;
- }
- export interface AwsRdsDbClusterMember {
- /**
- * Whether the cluster member is the primary instance for the DB cluster.
- */
- IsClusterWriter?: Boolean;
- /**
- * Specifies the order in which an Aurora replica is promoted to the primary instance when the existing primary instance fails.
- */
- PromotionTier?: Integer;
- /**
- * The instance identifier for this member of the DB cluster.
- */
- DbInstanceIdentifier?: NonEmptyString;
- /**
- * The status of the DB cluster parameter group for this member of the DB cluster.
- */
- DbClusterParameterGroupStatus?: NonEmptyString;
- }
- export type AwsRdsDbClusterMembers = AwsRdsDbClusterMember[];
- export interface AwsRdsDbClusterOptionGroupMembership {
- /**
- * The name of the DB cluster option group.
- */
- DbClusterOptionGroupName?: NonEmptyString;
- /**
- * The status of the DB cluster option group.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbClusterOptionGroupMemberships = AwsRdsDbClusterOptionGroupMembership[];
- export interface AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute {
- /**
- * The name of the manual DB cluster snapshot attribute. The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot.
- */
- AttributeName?: NonEmptyString;
- /**
- * The value(s) for the manual DB cluster snapshot attribute. If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of all is in the list, then the manual DB cluster snapshot is public and available for any Amazon Web Services account to copy or restore.
- */
- AttributeValues?: NonEmptyStringList;
- }
- export type AwsRdsDbClusterSnapshotDbClusterSnapshotAttributes = AwsRdsDbClusterSnapshotDbClusterSnapshotAttribute[];
- export interface AwsRdsDbClusterSnapshotDetails {
- /**
- * A list of Availability Zones where instances in the DB cluster can be created.
- */
- AvailabilityZones?: StringList;
- /**
- * Indicates when the snapshot was taken. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- SnapshotCreateTime?: NonEmptyString;
- /**
- * The name of the database engine that you want to use for this DB instance.
- */
- Engine?: NonEmptyString;
- /**
- * Specifies the allocated storage size in gibibytes (GiB).
- */
- AllocatedStorage?: Integer;
- /**
- * The status of this DB cluster snapshot.
- */
- Status?: NonEmptyString;
- /**
- * The port number on which the DB instances in the DB cluster accept connections.
- */
- Port?: Integer;
- /**
- * The VPC ID that is associated with the DB cluster snapshot.
- */
- VpcId?: NonEmptyString;
- /**
- * Indicates when the DB cluster was created, in Universal Coordinated Time (UTC). This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ClusterCreateTime?: NonEmptyString;
- /**
- * The name of the master user for the DB cluster.
- */
- MasterUsername?: NonEmptyString;
- /**
- * The version of the database engine to use.
- */
- EngineVersion?: NonEmptyString;
- /**
- * The license model information for this DB cluster snapshot.
- */
- LicenseModel?: NonEmptyString;
- /**
- * The type of DB cluster snapshot.
- */
- SnapshotType?: NonEmptyString;
- /**
- * Specifies the percentage of the estimated data that has been transferred.
- */
- PercentProgress?: Integer;
- /**
- * Whether the DB cluster is encrypted.
- */
- StorageEncrypted?: Boolean;
- /**
- * The ARN of the KMS master key that is used to encrypt the database instances in the DB cluster.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The DB cluster identifier.
- */
- DbClusterIdentifier?: NonEmptyString;
- /**
- * The identifier of the DB cluster snapshot.
- */
- DbClusterSnapshotIdentifier?: NonEmptyString;
- /**
- * Whether mapping of IAM accounts to database accounts is enabled.
- */
- IamDatabaseAuthenticationEnabled?: Boolean;
- /**
- * Contains the name and values of a manual DB cluster snapshot attribute.
- */
- DbClusterSnapshotAttributes?: AwsRdsDbClusterSnapshotDbClusterSnapshotAttributes;
- }
- export interface AwsRdsDbDomainMembership {
- /**
- * The identifier of the Active Directory domain.
- */
- Domain?: NonEmptyString;
- /**
- * The status of the Active Directory Domain membership for the DB instance.
- */
- Status?: NonEmptyString;
- /**
- * The fully qualified domain name of the Active Directory domain.
- */
- Fqdn?: NonEmptyString;
- /**
- * The name of the IAM role to use when making API calls to the Directory Service.
- */
- IamRoleName?: NonEmptyString;
- }
- export type AwsRdsDbDomainMemberships = AwsRdsDbDomainMembership[];
- export interface AwsRdsDbInstanceAssociatedRole {
- /**
- * The ARN of the IAM role that is associated with the DB instance.
- */
- RoleArn?: NonEmptyString;
- /**
- * The name of the feature associated with the IAM role.
- */
- FeatureName?: NonEmptyString;
- /**
- * Describes the state of the association between the IAM role and the DB instance. The Status property returns one of the following values: ACTIVE - The IAM role ARN is associated with the DB instance and can be used to access other Amazon Web Services services on your behalf. PENDING - The IAM role ARN is being associated with the DB instance. INVALID - The IAM role ARN is associated with the DB instance. But the DB instance is unable to assume the IAM role in order to access other Amazon Web Services services on your behalf.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbInstanceAssociatedRoles = AwsRdsDbInstanceAssociatedRole[];
- export interface AwsRdsDbInstanceDetails {
- /**
- * The IAM roles associated with the DB instance.
- */
- AssociatedRoles?: AwsRdsDbInstanceAssociatedRoles;
- /**
- * The identifier of the CA certificate for this DB instance.
- */
- CACertificateIdentifier?: NonEmptyString;
- /**
- * If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
- */
- DBClusterIdentifier?: NonEmptyString;
- /**
- * Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
- */
- DBInstanceIdentifier?: NonEmptyString;
- /**
- * Contains the name of the compute and memory capacity class of the DB instance.
- */
- DBInstanceClass?: NonEmptyString;
- /**
- * Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
- */
- DbInstancePort?: Integer;
- /**
- * The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in CloudTrail log entries whenever the KMS key for the DB instance is accessed.
- */
- DbiResourceId?: NonEmptyString;
- /**
- * The meaning of this parameter differs according to the database engine you use. MySQL, MariaDB, SQL Server, PostgreSQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance. Oracle Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.
- */
- DBName?: NonEmptyString;
- /**
- * Indicates whether the DB instance has deletion protection enabled. When deletion protection is enabled, the database cannot be deleted.
- */
- DeletionProtection?: Boolean;
- /**
- * Specifies the connection endpoint.
- */
- Endpoint?: AwsRdsDbInstanceEndpoint;
- /**
- * Provides the name of the database engine to use for this DB instance.
- */
- Engine?: NonEmptyString;
- /**
- * Indicates the database engine version.
- */
- EngineVersion?: NonEmptyString;
- /**
- * True if mapping of IAM accounts to database accounts is enabled, and otherwise false. IAM database authentication can be enabled for the following database engines. For MySQL 5.6, minor version 5.6.34 or higher For MySQL 5.7, minor version 5.7.16 or higher Aurora 5.6 or higher
- */
- IAMDatabaseAuthenticationEnabled?: Boolean;
- /**
- * Indicates when the DB instance was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- InstanceCreateTime?: NonEmptyString;
- /**
- * If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
- */
- PubliclyAccessible?: Boolean;
- /**
- * Specifies whether the DB instance is encrypted.
- */
- StorageEncrypted?: Boolean;
- /**
- * The ARN from the key store with which the instance is associated for TDE encryption.
- */
- TdeCredentialArn?: NonEmptyString;
- /**
- * A list of VPC security groups that the DB instance belongs to.
- */
- VpcSecurityGroups?: AwsRdsDbInstanceVpcSecurityGroups;
- /**
- * Whether the DB instance is a multiple Availability Zone deployment.
- */
- MultiAz?: Boolean;
- /**
- * The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.
- */
- EnhancedMonitoringResourceArn?: NonEmptyString;
- /**
- * The current status of the DB instance.
- */
- DbInstanceStatus?: NonEmptyString;
- /**
- * The master user name of the DB instance.
- */
- MasterUsername?: NonEmptyString;
- /**
- * The amount of storage (in gigabytes) to initially allocate for the DB instance.
- */
- AllocatedStorage?: Integer;
- /**
- * The range of time each day when automated backups are created, if automated backups are enabled. Uses the format HH:MM-HH:MM. For example, 04:52-05:22.
- */
- PreferredBackupWindow?: NonEmptyString;
- /**
- * The number of days for which to retain automated backups.
- */
- BackupRetentionPeriod?: Integer;
- /**
- * A list of the DB security groups to assign to the DB instance.
- */
- DbSecurityGroups?: StringList;
- /**
- * A list of the DB parameter groups to assign to the DB instance.
- */
- DbParameterGroups?: AwsRdsDbParameterGroups;
- /**
- * The Availability Zone where the DB instance will be created.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * Information about the subnet group that is associated with the DB instance.
- */
- DbSubnetGroup?: AwsRdsDbSubnetGroup;
- /**
- * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Uses the format <day>:HH:MM-<day>:HH:MM. For the day values, use mon|tue|wed|thu|fri|sat|sun. For example, sun:09:32-sun:10:02.
- */
- PreferredMaintenanceWindow?: NonEmptyString;
- /**
- * Changes to the DB instance that are currently pending.
- */
- PendingModifiedValues?: AwsRdsDbPendingModifiedValues;
- /**
- * Specifies the latest time to which a database can be restored with point-in-time restore. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LatestRestorableTime?: NonEmptyString;
- /**
- * Indicates whether minor version patches are applied automatically.
- */
- AutoMinorVersionUpgrade?: Boolean;
- /**
- * If this DB instance is a read replica, contains the identifier of the source DB instance.
- */
- ReadReplicaSourceDBInstanceIdentifier?: NonEmptyString;
- /**
- * List of identifiers of the read replicas associated with this DB instance.
- */
- ReadReplicaDBInstanceIdentifiers?: StringList;
- /**
- * List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.
- */
- ReadReplicaDBClusterIdentifiers?: StringList;
- /**
- * License model information for this DB instance.
- */
- LicenseModel?: NonEmptyString;
- /**
- * Specifies the provisioned IOPS (I/O operations per second) for this DB instance.
- */
- Iops?: Integer;
- /**
- * The list of option group memberships for this DB instance.
- */
- OptionGroupMemberships?: AwsRdsDbOptionGroupMemberships;
- /**
- * The name of the character set that this DB instance is associated with.
- */
- CharacterSetName?: NonEmptyString;
- /**
- * For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.
- */
- SecondaryAvailabilityZone?: NonEmptyString;
- /**
- * The status of a read replica. If the instance isn't a read replica, this is empty.
- */
- StatusInfos?: AwsRdsDbStatusInfos;
- /**
- * The storage type for the DB instance.
- */
- StorageType?: NonEmptyString;
- /**
- * The Active Directory domain membership records associated with the DB instance.
- */
- DomainMemberships?: AwsRdsDbDomainMemberships;
- /**
- * Whether to copy resource tags to snapshots of the DB instance.
- */
- CopyTagsToSnapshot?: Boolean;
- /**
- * The interval, in seconds, between points when enhanced monitoring metrics are collected for the DB instance.
- */
- MonitoringInterval?: Integer;
- /**
- * The ARN for the IAM role that permits Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.
- */
- MonitoringRoleArn?: NonEmptyString;
- /**
- * The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.
- */
- PromotionTier?: Integer;
- /**
- * The time zone of the DB instance.
- */
- Timezone?: NonEmptyString;
- /**
- * Indicates whether Performance Insights is enabled for the DB instance.
- */
- PerformanceInsightsEnabled?: Boolean;
- /**
- * The identifier of the KMS key used to encrypt the Performance Insights data.
- */
- PerformanceInsightsKmsKeyId?: NonEmptyString;
- /**
- * The number of days to retain Performance Insights data.
- */
- PerformanceInsightsRetentionPeriod?: Integer;
- /**
- * A list of log types that this DB instance is configured to export to CloudWatch Logs.
- */
- EnabledCloudWatchLogsExports?: StringList;
- /**
- * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- */
- ProcessorFeatures?: AwsRdsDbProcessorFeatures;
- ListenerEndpoint?: AwsRdsDbInstanceEndpoint;
- /**
- * The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
- */
- MaxAllocatedStorage?: Integer;
- }
- export interface AwsRdsDbInstanceEndpoint {
- /**
- * Specifies the DNS address of the DB instance.
- */
- Address?: NonEmptyString;
- /**
- * Specifies the port that the database engine is listening on.
- */
- Port?: Integer;
- /**
- * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
- */
- HostedZoneId?: NonEmptyString;
- }
- export interface AwsRdsDbInstanceVpcSecurityGroup {
- /**
- * The name of the VPC security group.
- */
- VpcSecurityGroupId?: NonEmptyString;
- /**
- * The status of the VPC security group.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbInstanceVpcSecurityGroups = AwsRdsDbInstanceVpcSecurityGroup[];
- export interface AwsRdsDbOptionGroupMembership {
- /**
- * The name of the option group.
- */
- OptionGroupName?: NonEmptyString;
- /**
- * The status of the option group membership.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbOptionGroupMemberships = AwsRdsDbOptionGroupMembership[];
- export interface AwsRdsDbParameterGroup {
- /**
- * The name of the parameter group.
- */
- DbParameterGroupName?: NonEmptyString;
- /**
- * The status of parameter updates.
- */
- ParameterApplyStatus?: NonEmptyString;
- }
- export type AwsRdsDbParameterGroups = AwsRdsDbParameterGroup[];
- export interface AwsRdsDbPendingModifiedValues {
- /**
- * The new DB instance class for the DB instance.
- */
- DbInstanceClass?: NonEmptyString;
- /**
- * The new value of the allocated storage for the DB instance.
- */
- AllocatedStorage?: Integer;
- /**
- * The new master user password for the DB instance.
- */
- MasterUserPassword?: NonEmptyString;
- /**
- * The new port for the DB instance.
- */
- Port?: Integer;
- /**
- * The new backup retention period for the DB instance.
- */
- BackupRetentionPeriod?: Integer;
- /**
- * Indicates that a single Availability Zone DB instance is changing to a multiple Availability Zone deployment.
- */
- MultiAZ?: Boolean;
- /**
- * The new engine version for the DB instance.
- */
- EngineVersion?: NonEmptyString;
- /**
- * The new license model value for the DB instance.
- */
- LicenseModel?: NonEmptyString;
- /**
- * The new provisioned IOPS value for the DB instance.
- */
- Iops?: Integer;
- /**
- * The new DB instance identifier for the DB instance.
- */
- DbInstanceIdentifier?: NonEmptyString;
- /**
- * The new storage type for the DB instance.
- */
- StorageType?: NonEmptyString;
- /**
- * The new CA certificate identifier for the DB instance.
- */
- CaCertificateIdentifier?: NonEmptyString;
- /**
- * The name of the new subnet group for the DB instance.
- */
- DbSubnetGroupName?: NonEmptyString;
- /**
- * A list of log types that are being enabled or disabled.
- */
- PendingCloudWatchLogsExports?: AwsRdsPendingCloudWatchLogsExports;
- /**
- * Processor features that are being updated.
- */
- ProcessorFeatures?: AwsRdsDbProcessorFeatures;
- }
- export interface AwsRdsDbProcessorFeature {
- /**
- * The name of the processor feature. Valid values are coreCount or threadsPerCore.
- */
- Name?: NonEmptyString;
- /**
- * The value of the processor feature.
- */
- Value?: NonEmptyString;
- }
- export type AwsRdsDbProcessorFeatures = AwsRdsDbProcessorFeature[];
- export interface AwsRdsDbSecurityGroupDetails {
- /**
- * The ARN for the DB security group.
- */
- DbSecurityGroupArn?: NonEmptyString;
- /**
- * Provides the description of the DB security group.
- */
- DbSecurityGroupDescription?: NonEmptyString;
- /**
- * Specifies the name of the DB security group.
- */
- DbSecurityGroupName?: NonEmptyString;
- /**
- * Contains a list of EC2 security groups.
- */
- Ec2SecurityGroups?: AwsRdsDbSecurityGroupEc2SecurityGroups;
- /**
- * Contains a list of IP ranges.
- */
- IpRanges?: AwsRdsDbSecurityGroupIpRanges;
- /**
- * Provides the Amazon Web Services ID of the owner of a specific DB security group.
- */
- OwnerId?: NonEmptyString;
- /**
- * Provides VPC ID associated with the DB security group.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsRdsDbSecurityGroupEc2SecurityGroup {
- /**
- * Specifies the ID for the EC2 security group.
- */
- Ec2SecurityGroupId?: NonEmptyString;
- /**
- * Specifies the name of the EC2 security group.
- */
- Ec2SecurityGroupName?: NonEmptyString;
- /**
- * Provides the Amazon Web Services ID of the owner of the EC2 security group.
- */
- Ec2SecurityGroupOwnerId?: NonEmptyString;
- /**
- * Provides the status of the EC2 security group.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbSecurityGroupEc2SecurityGroups = AwsRdsDbSecurityGroupEc2SecurityGroup[];
- export interface AwsRdsDbSecurityGroupIpRange {
- /**
- * Specifies the IP range.
- */
- CidrIp?: NonEmptyString;
- /**
- * Specifies the status of the IP range.
- */
- Status?: NonEmptyString;
- }
- export type AwsRdsDbSecurityGroupIpRanges = AwsRdsDbSecurityGroupIpRange[];
- export interface AwsRdsDbSnapshotDetails {
- /**
- * The name or ARN of the DB snapshot that is used to restore the DB instance.
- */
- DbSnapshotIdentifier?: NonEmptyString;
- /**
- * A name for the DB instance.
- */
- DbInstanceIdentifier?: NonEmptyString;
- /**
- * When the snapshot was taken in Coordinated Universal Time (UTC).
- */
- SnapshotCreateTime?: NonEmptyString;
- /**
- * The name of the database engine to use for this DB instance. Valid values are as follows: aurora aurora-mysql aurora-postgresql c mariadb mysql oracle-ee oracle-se oracle-se1 oracle-se2 sqlserver-ee sqlserver-ex sqlserver-se sqlserver-web
- */
- Engine?: NonEmptyString;
- /**
- * The amount of storage (in gigabytes) to be initially allocated for the database instance.
- */
- AllocatedStorage?: Integer;
- /**
- * The status of this DB snapshot.
- */
- Status?: NonEmptyString;
- /**
- * The port that the database engine was listening on at the time of the snapshot.
- */
- Port?: Integer;
- /**
- * Specifies the name of the Availability Zone in which the DB instance was located at the time of the DB snapshot.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * The VPC ID associated with the DB snapshot.
- */
- VpcId?: NonEmptyString;
- /**
- * Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
- */
- InstanceCreateTime?: NonEmptyString;
- /**
- * The master user name for the DB snapshot.
- */
- MasterUsername?: NonEmptyString;
- /**
- * The version of the database engine.
- */
- EngineVersion?: NonEmptyString;
- /**
- * License model information for the restored DB instance.
- */
- LicenseModel?: NonEmptyString;
- /**
- * The type of the DB snapshot.
- */
- SnapshotType?: NonEmptyString;
- /**
- * The provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
- */
- Iops?: Integer;
- /**
- * The option group name for the DB snapshot.
- */
- OptionGroupName?: NonEmptyString;
- /**
- * The percentage of the estimated data that has been transferred.
- */
- PercentProgress?: Integer;
- /**
- * The Amazon Web Services Region that the DB snapshot was created in or copied from.
- */
- SourceRegion?: NonEmptyString;
- /**
- * The DB snapshot ARN that the DB snapshot was copied from.
- */
- SourceDbSnapshotIdentifier?: NonEmptyString;
- /**
- * The storage type associated with the DB snapshot. Valid values are as follows: gp2 io1 standard
- */
- StorageType?: NonEmptyString;
- /**
- * The ARN from the key store with which to associate the instance for TDE encryption.
- */
- TdeCredentialArn?: NonEmptyString;
- /**
- * Whether the DB snapshot is encrypted.
- */
- Encrypted?: Boolean;
- /**
- * If Encrypted is true, the KMS key identifier for the encrypted DB snapshot.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The time zone of the DB snapshot.
- */
- Timezone?: NonEmptyString;
- /**
- * Whether mapping of IAM accounts to database accounts is enabled.
- */
- IamDatabaseAuthenticationEnabled?: Boolean;
- /**
- * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
- */
- ProcessorFeatures?: AwsRdsDbProcessorFeatures;
- /**
- * The identifier for the source DB instance.
- */
- DbiResourceId?: NonEmptyString;
- }
- export interface AwsRdsDbStatusInfo {
- /**
- * The type of status. For a read replica, the status type is read replication.
- */
- StatusType?: NonEmptyString;
- /**
- * Whether the read replica instance is operating normally.
- */
- Normal?: Boolean;
- /**
- * The status of the read replica instance.
- */
- Status?: NonEmptyString;
- /**
- * If the read replica is currently in an error state, provides the error details.
- */
- Message?: NonEmptyString;
- }
- export type AwsRdsDbStatusInfos = AwsRdsDbStatusInfo[];
- export interface AwsRdsDbSubnetGroup {
- /**
- * The name of the subnet group.
- */
- DbSubnetGroupName?: NonEmptyString;
- /**
- * The description of the subnet group.
- */
- DbSubnetGroupDescription?: NonEmptyString;
- /**
- * The VPC ID of the subnet group.
- */
- VpcId?: NonEmptyString;
- /**
- * The status of the subnet group.
- */
- SubnetGroupStatus?: NonEmptyString;
- /**
- * A list of subnets in the subnet group.
- */
- Subnets?: AwsRdsDbSubnetGroupSubnets;
- /**
- * The ARN of the subnet group.
- */
- DbSubnetGroupArn?: NonEmptyString;
- }
- export interface AwsRdsDbSubnetGroupSubnet {
- /**
- * The identifier of a subnet in the subnet group.
- */
- SubnetIdentifier?: NonEmptyString;
- /**
- * Information about the Availability Zone for a subnet in the subnet group.
- */
- SubnetAvailabilityZone?: AwsRdsDbSubnetGroupSubnetAvailabilityZone;
- /**
- * The status of a subnet in the subnet group.
- */
- SubnetStatus?: NonEmptyString;
- }
- export interface AwsRdsDbSubnetGroupSubnetAvailabilityZone {
- /**
- * The name of the Availability Zone for a subnet in the subnet group.
- */
- Name?: NonEmptyString;
- }
- export type AwsRdsDbSubnetGroupSubnets = AwsRdsDbSubnetGroupSubnet[];
- export interface AwsRdsEventSubscriptionDetails {
- /**
- * The identifier of the account that is associated with the event notification subscription.
- */
- CustSubscriptionId?: NonEmptyString;
- /**
- * The identifier of the event notification subscription.
- */
- CustomerAwsId?: NonEmptyString;
- /**
- * Whether the event notification subscription is enabled.
- */
- Enabled?: Boolean;
- /**
- * The list of event categories for the event notification subscription.
- */
- EventCategoriesList?: NonEmptyStringList;
- /**
- * The ARN of the event notification subscription.
- */
- EventSubscriptionArn?: NonEmptyString;
- /**
- * The ARN of the SNS topic to post the event notifications to.
- */
- SnsTopicArn?: NonEmptyString;
- /**
- * A list of source identifiers for the event notification subscription.
- */
- SourceIdsList?: NonEmptyStringList;
- /**
- * The source type for the event notification subscription.
- */
- SourceType?: NonEmptyString;
- /**
- * The status of the event notification subscription. Valid values: creating | modifying | deleting | active | no-permission | topic-not-exist
- */
- Status?: NonEmptyString;
- /**
- * The datetime when the event notification subscription was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- SubscriptionCreationTime?: NonEmptyString;
- }
- export interface AwsRdsPendingCloudWatchLogsExports {
- /**
- * A list of log types that are being enabled.
- */
- LogTypesToEnable?: StringList;
- /**
- * A list of log types that are being disabled.
- */
- LogTypesToDisable?: StringList;
- }
- export interface AwsRedshiftClusterClusterNode {
- /**
- * The role of the node. A node might be a leader node or a compute node.
- */
- NodeRole?: NonEmptyString;
- /**
- * The private IP address of the node.
- */
- PrivateIpAddress?: NonEmptyString;
- /**
- * The public IP address of the node.
- */
- PublicIpAddress?: NonEmptyString;
- }
- export type AwsRedshiftClusterClusterNodes = AwsRedshiftClusterClusterNode[];
- export interface AwsRedshiftClusterClusterParameterGroup {
- /**
- * The list of parameter statuses.
- */
- ClusterParameterStatusList?: AwsRedshiftClusterClusterParameterStatusList;
- /**
- * The status of updates to the parameters.
- */
- ParameterApplyStatus?: NonEmptyString;
- /**
- * The name of the parameter group.
- */
- ParameterGroupName?: NonEmptyString;
- }
- export type AwsRedshiftClusterClusterParameterGroups = AwsRedshiftClusterClusterParameterGroup[];
- export interface AwsRedshiftClusterClusterParameterStatus {
- /**
- * The name of the parameter.
- */
- ParameterName?: NonEmptyString;
- /**
- * The status of the parameter. Indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when it was applied. Valid values: in-sync | pending-reboot | applying | invalid-parameter | apply-deferred | apply-error | unknown-error
- */
- ParameterApplyStatus?: NonEmptyString;
- /**
- * The error that prevented the parameter from being applied to the database.
- */
- ParameterApplyErrorDescription?: NonEmptyString;
- }
- export type AwsRedshiftClusterClusterParameterStatusList = AwsRedshiftClusterClusterParameterStatus[];
- export interface AwsRedshiftClusterClusterSecurityGroup {
- /**
- * The name of the cluster security group.
- */
- ClusterSecurityGroupName?: NonEmptyString;
- /**
- * The status of the cluster security group.
- */
- Status?: NonEmptyString;
- }
- export type AwsRedshiftClusterClusterSecurityGroups = AwsRedshiftClusterClusterSecurityGroup[];
- export interface AwsRedshiftClusterClusterSnapshotCopyStatus {
- /**
- * The destination Region that snapshots are automatically copied to when cross-Region snapshot copy is enabled.
- */
- DestinationRegion?: NonEmptyString;
- /**
- * The number of days that manual snapshots are retained in the destination Region after they are copied from a source Region. If the value is -1, then the manual snapshot is retained indefinitely. Valid values: Either -1 or an integer between 1 and 3,653
- */
- ManualSnapshotRetentionPeriod?: Integer;
- /**
- * The number of days to retain automated snapshots in the destination Region after they are copied from a source Region.
- */
- RetentionPeriod?: Integer;
- /**
- * The name of the snapshot copy grant.
- */
- SnapshotCopyGrantName?: NonEmptyString;
- }
- export interface AwsRedshiftClusterDeferredMaintenanceWindow {
- /**
- * The end of the time window for which maintenance was deferred. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- DeferMaintenanceEndTime?: NonEmptyString;
- /**
- * The identifier of the maintenance window.
- */
- DeferMaintenanceIdentifier?: NonEmptyString;
- /**
- * The start of the time window for which maintenance was deferred. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- DeferMaintenanceStartTime?: NonEmptyString;
- }
- export type AwsRedshiftClusterDeferredMaintenanceWindows = AwsRedshiftClusterDeferredMaintenanceWindow[];
- export interface AwsRedshiftClusterDetails {
- /**
- * Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
- */
- AllowVersionUpgrade?: Boolean;
- /**
- * The number of days that automatic cluster snapshots are retained.
- */
- AutomatedSnapshotRetentionPeriod?: Integer;
- /**
- * The name of the Availability Zone in which the cluster is located.
- */
- AvailabilityZone?: NonEmptyString;
- /**
- * The availability status of the cluster for queries. Possible values are the following: Available - The cluster is available for queries. Unavailable - The cluster is not available for queries. Maintenance - The cluster is intermittently available for queries due to maintenance activities. Modifying -The cluster is intermittently available for queries due to changes that modify the cluster. Failed - The cluster failed and is not available for queries.
- */
- ClusterAvailabilityStatus?: NonEmptyString;
- /**
- * Indicates when the cluster was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ClusterCreateTime?: NonEmptyString;
- /**
- * The unique identifier of the cluster.
- */
- ClusterIdentifier?: NonEmptyString;
- /**
- * The nodes in the cluster.
- */
- ClusterNodes?: AwsRedshiftClusterClusterNodes;
- /**
- * The list of cluster parameter groups that are associated with this cluster.
- */
- ClusterParameterGroups?: AwsRedshiftClusterClusterParameterGroups;
- /**
- * The public key for the cluster.
- */
- ClusterPublicKey?: NonEmptyString;
- /**
- * The specific revision number of the database in the cluster.
- */
- ClusterRevisionNumber?: NonEmptyString;
- /**
- * A list of cluster security groups that are associated with the cluster.
- */
- ClusterSecurityGroups?: AwsRedshiftClusterClusterSecurityGroups;
- /**
- * Information about the destination Region and retention period for the cross-Region snapshot copy.
- */
- ClusterSnapshotCopyStatus?: AwsRedshiftClusterClusterSnapshotCopyStatus;
- /**
- * The current status of the cluster. Valid values: available | available, prep-for-resize | available, resize-cleanup | cancelling-resize | creating | deleting | final-snapshot | hardware-failure | incompatible-hsm | incompatible-network | incompatible-parameters | incompatible-restore | modifying | paused | rebooting | renaming | resizing | rotating-keys | storage-full | updating-hsm
- */
- ClusterStatus?: NonEmptyString;
- /**
- * The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
- */
- ClusterSubnetGroupName?: NonEmptyString;
- /**
- * The version ID of the Amazon Redshift engine that runs on the cluster.
- */
- ClusterVersion?: NonEmptyString;
- /**
- * The name of the initial database that was created when the cluster was created. The same name is returned for the life of the cluster. If an initial database is not specified, a database named devdev is created by default.
- */
- DBName?: NonEmptyString;
- /**
- * List of time windows during which maintenance was deferred.
- */
- DeferredMaintenanceWindows?: AwsRedshiftClusterDeferredMaintenanceWindows;
- /**
- * Information about the status of the Elastic IP (EIP) address.
- */
- ElasticIpStatus?: AwsRedshiftClusterElasticIpStatus;
- /**
- * The number of nodes that you can use the elastic resize method to resize the cluster to.
- */
- ElasticResizeNumberOfNodeOptions?: NonEmptyString;
- /**
- * Indicates whether the data in the cluster is encrypted at rest.
- */
- Encrypted?: Boolean;
- /**
- * The connection endpoint.
- */
- Endpoint?: AwsRedshiftClusterEndpoint;
- /**
- * Indicates whether to create the cluster with enhanced VPC routing enabled.
- */
- EnhancedVpcRouting?: Boolean;
- /**
- * Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ExpectedNextSnapshotScheduleTime?: NonEmptyString;
- /**
- * The status of the next expected snapshot. Valid values: OnTrack | Pending
- */
- ExpectedNextSnapshotScheduleTimeStatus?: NonEmptyString;
- /**
- * Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.
- */
- HsmStatus?: AwsRedshiftClusterHsmStatus;
- /**
- * A list of IAM roles that the cluster can use to access other Amazon Web Services services.
- */
- IamRoles?: AwsRedshiftClusterIamRoles;
- /**
- * The identifier of the KMS encryption key that is used to encrypt data in the cluster.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The name of the maintenance track for the cluster.
- */
- MaintenanceTrackName?: NonEmptyString;
- /**
- * The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values: Either -1 or an integer between 1 and 3,653
- */
- ManualSnapshotRetentionPeriod?: Integer;
- /**
- * The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName.
- */
- MasterUsername?: NonEmptyString;
- /**
- * Indicates the start of the next maintenance window. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- NextMaintenanceWindowStartTime?: NonEmptyString;
- /**
- * The node type for the nodes in the cluster.
- */
- NodeType?: NonEmptyString;
- /**
- * The number of compute nodes in the cluster.
- */
- NumberOfNodes?: Integer;
- /**
- * A list of cluster operations that are waiting to start.
- */
- PendingActions?: StringList;
- /**
- * A list of changes to the cluster that are currently pending.
- */
- PendingModifiedValues?: AwsRedshiftClusterPendingModifiedValues;
- /**
- * The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur. Format: <day>:HH:MM-<day>:HH:MM For the day values, use mon | tue | wed | thu | fri | sat | sun For example, sun:09:32-sun:10:02
- */
- PreferredMaintenanceWindow?: NonEmptyString;
- /**
- * Whether the cluster can be accessed from a public network.
- */
- PubliclyAccessible?: Boolean;
- /**
- * Information about the resize operation for the cluster.
- */
- ResizeInfo?: AwsRedshiftClusterResizeInfo;
- /**
- * Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
- */
- RestoreStatus?: AwsRedshiftClusterRestoreStatus;
- /**
- * A unique identifier for the cluster snapshot schedule.
- */
- SnapshotScheduleIdentifier?: NonEmptyString;
- /**
- * The current state of the cluster snapshot schedule. Valid values: MODIFYING | ACTIVE | FAILED
- */
- SnapshotScheduleState?: NonEmptyString;
- /**
- * The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
- */
- VpcId?: NonEmptyString;
- /**
- * The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
- */
- VpcSecurityGroups?: AwsRedshiftClusterVpcSecurityGroups;
- /**
- * Information about the logging status of the cluster.
- */
- LoggingStatus?: AwsRedshiftClusterLoggingStatus;
- }
- export interface AwsRedshiftClusterElasticIpStatus {
- /**
- * The elastic IP address for the cluster.
- */
- ElasticIp?: NonEmptyString;
- /**
- * The status of the elastic IP address.
- */
- Status?: NonEmptyString;
- }
- export interface AwsRedshiftClusterEndpoint {
- /**
- * The DNS address of the cluster.
- */
- Address?: NonEmptyString;
- /**
- * The port that the database engine listens on.
- */
- Port?: Integer;
- }
- export interface AwsRedshiftClusterHsmStatus {
- /**
- * The name of the HSM client certificate that the Amazon Redshift cluster uses to retrieve the data encryption keys that are stored in an HSM.
- */
- HsmClientCertificateIdentifier?: NonEmptyString;
- /**
- * The name of the HSM configuration that contains the information that the Amazon Redshift cluster can use to retrieve and store keys in an HSM.
- */
- HsmConfigurationIdentifier?: NonEmptyString;
- /**
- * Indicates whether the Amazon Redshift cluster has finished applying any HSM settings changes specified in a modify cluster command. Type: String Valid values: active | applying
- */
- Status?: NonEmptyString;
- }
- export interface AwsRedshiftClusterIamRole {
- /**
- * The status of the IAM role's association with the cluster. Valid values: in-sync | adding | removing
- */
- ApplyStatus?: NonEmptyString;
- /**
- * The ARN of the IAM role.
- */
- IamRoleArn?: NonEmptyString;
- }
- export type AwsRedshiftClusterIamRoles = AwsRedshiftClusterIamRole[];
- export interface AwsRedshiftClusterLoggingStatus {
- /**
- * The name of the S3 bucket where the log files are stored.
- */
- BucketName?: NonEmptyString;
- /**
- * The message indicating that the logs failed to be delivered.
- */
- LastFailureMessage?: NonEmptyString;
- /**
- * The last time when logs failed to be delivered. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastFailureTime?: NonEmptyString;
- /**
- * The last time that logs were delivered successfully. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastSuccessfulDeliveryTime?: NonEmptyString;
- /**
- * Indicates whether logging is enabled.
- */
- LoggingEnabled?: Boolean;
- /**
- * Provides the prefix applied to the log file names.
- */
- S3KeyPrefix?: NonEmptyString;
- }
- export interface AwsRedshiftClusterPendingModifiedValues {
- /**
- * The pending or in-progress change to the automated snapshot retention period.
- */
- AutomatedSnapshotRetentionPeriod?: Integer;
- /**
- * The pending or in-progress change to the identifier for the cluster.
- */
- ClusterIdentifier?: NonEmptyString;
- /**
- * The pending or in-progress change to the cluster type.
- */
- ClusterType?: NonEmptyString;
- /**
- * The pending or in-progress change to the service version.
- */
- ClusterVersion?: NonEmptyString;
- /**
- * The encryption type for a cluster.
- */
- EncryptionType?: NonEmptyString;
- /**
- * Indicates whether to create the cluster with enhanced VPC routing enabled.
- */
- EnhancedVpcRouting?: Boolean;
- /**
- * The name of the maintenance track that the cluster changes to during the next maintenance window.
- */
- MaintenanceTrackName?: NonEmptyString;
- /**
- * The pending or in-progress change to the master user password for the cluster.
- */
- MasterUserPassword?: NonEmptyString;
- /**
- * The pending or in-progress change to the cluster's node type.
- */
- NodeType?: NonEmptyString;
- /**
- * The pending or in-progress change to the number of nodes in the cluster.
- */
- NumberOfNodes?: Integer;
- /**
- * The pending or in-progress change to whether the cluster can be connected to from the public network.
- */
- PubliclyAccessible?: Boolean;
- }
- export interface AwsRedshiftClusterResizeInfo {
- /**
- * Indicates whether the resize operation can be canceled.
- */
- AllowCancelResize?: Boolean;
- /**
- * The type of resize operation. Valid values: ClassicResize
- */
- ResizeType?: NonEmptyString;
- }
- export interface AwsRedshiftClusterRestoreStatus {
- /**
- * The number of megabytes per second being transferred from the backup storage. Returns the average rate for a completed backup. This field is only updated when you restore to DC2 and DS2 node types.
- */
- CurrentRestoreRateInMegaBytesPerSecond?: Double;
- /**
- * The amount of time an in-progress restore has been running, or the amount of time it took a completed restore to finish. This field is only updated when you restore to DC2 and DS2 node types.
- */
- ElapsedTimeInSeconds?: Long;
- /**
- * The estimate of the time remaining before the restore is complete. Returns 0 for a completed restore. This field is only updated when you restore to DC2 and DS2 node types.
- */
- EstimatedTimeToCompletionInSeconds?: Long;
- /**
- * The number of megabytes that were transferred from snapshot storage. This field is only updated when you restore to DC2 and DS2 node types.
- */
- ProgressInMegaBytes?: Long;
- /**
- * The size of the set of snapshot data that was used to restore the cluster. This field is only updated when you restore to DC2 and DS2 node types.
- */
- SnapshotSizeInMegaBytes?: Long;
- /**
- * The status of the restore action. Valid values: starting | restoring | completed | failed
- */
- Status?: NonEmptyString;
- }
- export interface AwsRedshiftClusterVpcSecurityGroup {
- /**
- * The status of the VPC security group.
- */
- Status?: NonEmptyString;
- /**
- * The identifier of the VPC security group.
- */
- VpcSecurityGroupId?: NonEmptyString;
- }
- export type AwsRedshiftClusterVpcSecurityGroups = AwsRedshiftClusterVpcSecurityGroup[];
- export interface AwsRoute53HostedZoneConfigDetails {
- /**
- * Any comments that you include about the hosted zone.
- */
- Comment?: NonEmptyString;
- }
- export interface AwsRoute53HostedZoneDetails {
- /**
- * An object that contains information about the specified hosted zone.
- */
- HostedZone?: AwsRoute53HostedZoneObjectDetails;
- /**
- * An object that contains information about the Amazon Virtual Private Clouds (Amazon VPCs) that are associated with the specified hosted zone.
- */
- Vpcs?: AwsRoute53HostedZoneVpcsList;
- /**
- * An object that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
- */
- NameServers?: AwsRoute53HostedZoneNameServersList;
- /**
- * An array that contains one QueryLoggingConfig element for each DNS query logging configuration that is associated with the current Amazon Web Services account.
- */
- QueryLoggingConfig?: AwsRoute53QueryLoggingConfigDetails;
- }
- export type AwsRoute53HostedZoneNameServersList = NonEmptyString[];
- export interface AwsRoute53HostedZoneObjectDetails {
- /**
- * The ID that Route 53 assigns to the hosted zone when you create it.
- */
- Id?: NonEmptyString;
- /**
- * The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
- */
- Name?: NonEmptyString;
- /**
- * An object that includes the Comment element.
- */
- Config?: AwsRoute53HostedZoneConfigDetails;
- }
- export interface AwsRoute53HostedZoneVpcDetails {
- /**
- * The identifier of an Amazon VPC.
- */
- Id?: NonEmptyString;
- /**
- * The Amazon Web Services Region that an Amazon VPC was created in.
- */
- Region?: NonEmptyString;
- }
- export type AwsRoute53HostedZoneVpcsList = AwsRoute53HostedZoneVpcDetails[];
- export interface AwsRoute53QueryLoggingConfigDetails {
- /**
- * The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log group that Route 53 is publishing logs to.
- */
- CloudWatchLogsLogGroupArn?: CloudWatchLogsLogGroupArnConfigDetails;
- }
- export interface AwsS3AccessPointDetails {
- /**
- * The Amazon Resource Name (ARN) of the access point.
- */
- AccessPointArn?: NonEmptyString;
- /**
- * The name or alias of the access point.
- */
- Alias?: NonEmptyString;
- /**
- * The name of the S3 bucket associated with the specified access point.
- */
- Bucket?: NonEmptyString;
- /**
- * The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
- */
- BucketAccountId?: NonEmptyString;
- /**
- * The name of the specified access point.
- */
- Name?: NonEmptyString;
- /**
- * Indicates whether this access point allows access from the public internet.
- */
- NetworkOrigin?: NonEmptyString;
- PublicAccessBlockConfiguration?: AwsS3AccountPublicAccessBlockDetails;
- /**
- * Contains the virtual private cloud (VPC) configuration for the specified access point.
- */
- VpcConfiguration?: AwsS3AccessPointVpcConfigurationDetails;
- }
- export interface AwsS3AccessPointVpcConfigurationDetails {
- /**
- * If this field is specified, this access point will only allow connections from the specified VPC ID.
- */
- VpcId?: NonEmptyString;
- }
- export interface AwsS3AccountPublicAccessBlockDetails {
- /**
- * Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).
- */
- BlockPublicAcls?: Boolean;
- /**
- * Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.
- */
- BlockPublicPolicy?: Boolean;
- /**
- * Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.
- */
- IgnorePublicAcls?: Boolean;
- /**
- * Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only Amazon Web Services service principals and authorized users within the S3 bucket owner's account.
- */
- RestrictPublicBuckets?: Boolean;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationDetails {
- /**
- * The lifecycle rules.
- */
- Rules?: AwsS3BucketBucketLifecycleConfigurationRulesList;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails {
- /**
- * The number of days after which Amazon S3 cancels an incomplete multipart upload.
- */
- DaysAfterInitiation?: Integer;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesDetails {
- /**
- * How Amazon S3 responds when a multipart upload is incomplete. Specifically, provides a number of days before Amazon S3 cancels the entire upload.
- */
- AbortIncompleteMultipartUpload?: AwsS3BucketBucketLifecycleConfigurationRulesAbortIncompleteMultipartUploadDetails;
- /**
- * The date when objects are moved or deleted. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ExpirationDate?: NonEmptyString;
- /**
- * The length in days of the lifetime for objects that are subject to the rule.
- */
- ExpirationInDays?: Integer;
- /**
- * Whether Amazon S3 removes a delete marker that has no noncurrent versions. If set to true, the delete marker is expired. If set to false, the policy takes no action. If you provide ExpiredObjectDeleteMarker, you cannot provide ExpirationInDays or ExpirationDate.
- */
- ExpiredObjectDeleteMarker?: Boolean;
- /**
- * Identifies the objects that a rule applies to.
- */
- Filter?: AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails;
- /**
- * The unique identifier of the rule.
- */
- ID?: NonEmptyString;
- /**
- * The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
- */
- NoncurrentVersionExpirationInDays?: Integer;
- /**
- * Transition rules that describe when noncurrent objects transition to a specified storage class.
- */
- NoncurrentVersionTransitions?: AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList;
- /**
- * A prefix that identifies one or more objects that the rule applies to.
- */
- Prefix?: NonEmptyString;
- /**
- * The current status of the rule. Indicates whether the rule is currently being applied.
- */
- Status?: NonEmptyString;
- /**
- * Transition rules that indicate when objects transition to a specified storage class.
- */
- Transitions?: AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesFilterDetails {
- /**
- * The configuration for the filter.
- */
- Predicate?: AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateDetails {
- /**
- * The values to use for the filter.
- */
- Operands?: AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList;
- /**
- * A prefix filter.
- */
- Prefix?: NonEmptyString;
- /**
- * A tag filter.
- */
- Tag?: AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails;
- /**
- * Whether to use AND or OR to join the operands. Valid values are LifecycleAndOperator or LifecycleOrOperator.
- */
- Type?: NonEmptyString;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails {
- /**
- * Prefix text for matching objects.
- */
- Prefix?: NonEmptyString;
- /**
- * A tag that is assigned to matching objects.
- */
- Tag?: AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails;
- /**
- * The type of filter value. Valid values are LifecyclePrefixPredicate or LifecycleTagPredicate.
- */
- Type?: NonEmptyString;
- }
- export type AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsList = AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsDetails[];
- export interface AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateOperandsTagDetails {
- /**
- * The tag key.
- */
- Key?: NonEmptyString;
- /**
- * The tag value.
- */
- Value?: NonEmptyString;
- }
- export interface AwsS3BucketBucketLifecycleConfigurationRulesFilterPredicateTagDetails {
- /**
- * The tag key.
- */
- Key?: NonEmptyString;
- /**
- * The tag value
- */
- Value?: NonEmptyString;
- }
- export type AwsS3BucketBucketLifecycleConfigurationRulesList = AwsS3BucketBucketLifecycleConfigurationRulesDetails[];
- export interface AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails {
- /**
- * The number of days that an object is noncurrent before Amazon S3 can perform the associated action.
- */
- Days?: Integer;
- /**
- * The class of storage to change the object to after the object is noncurrent for the specified number of days.
- */
- StorageClass?: NonEmptyString;
- }
- export type AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsList = AwsS3BucketBucketLifecycleConfigurationRulesNoncurrentVersionTransitionsDetails[];
- export interface AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails {
- /**
- * A date on which to transition objects to the specified storage class. If you provide Date, you cannot provide Days. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- Date?: NonEmptyString;
- /**
- * The number of days after which to transition the object to the specified storage class. If you provide Days, you cannot provide Date.
- */
- Days?: Integer;
- /**
- * The storage class to transition the object to. Valid values are as follows: DEEP_ARCHIVE GLACIER INTELLIGENT_TIERING ONEZONE_IA STANDARD_IA
- */
- StorageClass?: NonEmptyString;
- }
- export type AwsS3BucketBucketLifecycleConfigurationRulesTransitionsList = AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails[];
- export interface AwsS3BucketBucketVersioningConfiguration {
- /**
- * Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.
- */
- IsMfaDeleteEnabled?: Boolean;
- /**
- * The versioning status of the S3 bucket. Valid values are Enabled or Suspended.
- */
- Status?: NonEmptyString;
- }
- export interface AwsS3BucketDetails {
- /**
- * The canonical user ID of the owner of the S3 bucket.
- */
- OwnerId?: NonEmptyString;
- /**
- * The display name of the owner of the S3 bucket.
- */
- OwnerName?: NonEmptyString;
- /**
- * The Amazon Web Services account identifier of the account that owns the S3 bucket.
- */
- OwnerAccountId?: NonEmptyString;
- /**
- * Indicates when the S3 bucket was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: NonEmptyString;
- /**
- * The encryption rules that are applied to the S3 bucket.
- */
- ServerSideEncryptionConfiguration?: AwsS3BucketServerSideEncryptionConfiguration;
- /**
- * The lifecycle configuration for objects in the specified bucket.
- */
- BucketLifecycleConfiguration?: AwsS3BucketBucketLifecycleConfigurationDetails;
- /**
- * Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.
- */
- PublicAccessBlockConfiguration?: AwsS3AccountPublicAccessBlockDetails;
- /**
- * The access control list for the S3 bucket.
- */
- AccessControlList?: NonEmptyString;
- /**
- * The logging configuration for the S3 bucket.
- */
- BucketLoggingConfiguration?: AwsS3BucketLoggingConfiguration;
- /**
- * The website configuration parameters for the S3 bucket.
- */
- BucketWebsiteConfiguration?: AwsS3BucketWebsiteConfiguration;
- /**
- * The notification configuration for the S3 bucket.
- */
- BucketNotificationConfiguration?: AwsS3BucketNotificationConfiguration;
- /**
- * The versioning state of an S3 bucket.
- */
- BucketVersioningConfiguration?: AwsS3BucketBucketVersioningConfiguration;
- /**
- * Specifies which rule Amazon S3 applies by default to every new object placed in the bucket.
- */
- ObjectLockConfiguration?: AwsS3BucketObjectLockConfiguration;
- /**
- * The name of the bucket.
- */
- Name?: NonEmptyString;
- }
- export interface AwsS3BucketLoggingConfiguration {
- /**
- * The name of the S3 bucket where log files for the S3 bucket are stored.
- */
- DestinationBucketName?: NonEmptyString;
- /**
- * The prefix added to log files for the S3 bucket.
- */
- LogFilePrefix?: NonEmptyString;
- }
- export interface AwsS3BucketNotificationConfiguration {
- /**
- * Configurations for S3 bucket notifications.
- */
- Configurations?: AwsS3BucketNotificationConfigurationDetails;
- }
- export interface AwsS3BucketNotificationConfigurationDetail {
- /**
- * The list of events that trigger a notification.
- */
- Events?: AwsS3BucketNotificationConfigurationEvents;
- /**
- * The filters that determine which S3 buckets generate notifications.
- */
- Filter?: AwsS3BucketNotificationConfigurationFilter;
- /**
- * The ARN of the Lambda function, Amazon SQS queue, or Amazon SNS topic that generates the notification.
- */
- Destination?: NonEmptyString;
- /**
- * Indicates the type of notification. Notifications can be generated using Lambda functions, Amazon SQS queues, or Amazon SNS topics, with corresponding valid values as follows: LambdaConfiguration QueueConfiguration TopicConfiguration
- */
- Type?: NonEmptyString;
- }
- export type AwsS3BucketNotificationConfigurationDetails = AwsS3BucketNotificationConfigurationDetail[];
- export type AwsS3BucketNotificationConfigurationEvents = NonEmptyString[];
- export interface AwsS3BucketNotificationConfigurationFilter {
- /**
- * Details for an Amazon S3 filter.
- */
- S3KeyFilter?: AwsS3BucketNotificationConfigurationS3KeyFilter;
- }
- export interface AwsS3BucketNotificationConfigurationS3KeyFilter {
- /**
- * The filter rules for the filter.
- */
- FilterRules?: AwsS3BucketNotificationConfigurationS3KeyFilterRules;
- }
- export interface AwsS3BucketNotificationConfigurationS3KeyFilterRule {
- /**
- * Indicates whether the filter is based on the prefix or suffix of the Amazon S3 key.
- */
- Name?: AwsS3BucketNotificationConfigurationS3KeyFilterRuleName;
- /**
- * The filter value.
- */
- Value?: NonEmptyString;
- }
- export type AwsS3BucketNotificationConfigurationS3KeyFilterRuleName = "Prefix"|"Suffix"|string;
- export type AwsS3BucketNotificationConfigurationS3KeyFilterRules = AwsS3BucketNotificationConfigurationS3KeyFilterRule[];
- export interface AwsS3BucketObjectLockConfiguration {
- /**
- * Indicates whether the bucket has an Object Lock configuration enabled.
- */
- ObjectLockEnabled?: NonEmptyString;
- /**
- * Specifies the Object Lock rule for the specified object.
- */
- Rule?: AwsS3BucketObjectLockConfigurationRuleDetails;
- }
- export interface AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails {
- /**
- * The number of days that you want to specify for the default retention period.
- */
- Days?: Integer;
- /**
- * The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
- */
- Mode?: NonEmptyString;
- /**
- * The number of years that you want to specify for the default retention period.
- */
- Years?: Integer;
- }
- export interface AwsS3BucketObjectLockConfigurationRuleDetails {
- /**
- * The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket.
- */
- DefaultRetention?: AwsS3BucketObjectLockConfigurationRuleDefaultRetentionDetails;
- }
- export interface AwsS3BucketServerSideEncryptionByDefault {
- /**
- * Server-side encryption algorithm to use for the default encryption. Valid values are aws: kms or AES256.
- */
- SSEAlgorithm?: NonEmptyString;
- /**
- * KMS key ID to use for the default encryption.
- */
- KMSMasterKeyID?: NonEmptyString;
- }
- export interface AwsS3BucketServerSideEncryptionConfiguration {
- /**
- * The encryption rules that are applied to the S3 bucket.
- */
- Rules?: AwsS3BucketServerSideEncryptionRules;
- }
- export interface AwsS3BucketServerSideEncryptionRule {
- /**
- * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT object request doesn't specify any server-side encryption, this default encryption is applied.
- */
- ApplyServerSideEncryptionByDefault?: AwsS3BucketServerSideEncryptionByDefault;
- }
- export type AwsS3BucketServerSideEncryptionRules = AwsS3BucketServerSideEncryptionRule[];
- export interface AwsS3BucketWebsiteConfiguration {
- /**
- * The name of the error document for the website.
- */
- ErrorDocument?: NonEmptyString;
- /**
- * The name of the index document for the website.
- */
- IndexDocumentSuffix?: NonEmptyString;
- /**
- * The redirect behavior for requests to the website.
- */
- RedirectAllRequestsTo?: AwsS3BucketWebsiteConfigurationRedirectTo;
- /**
- * The rules for applying redirects for requests to the website.
- */
- RoutingRules?: AwsS3BucketWebsiteConfigurationRoutingRules;
- }
- export interface AwsS3BucketWebsiteConfigurationRedirectTo {
- /**
- * The name of the host to redirect requests to.
- */
- Hostname?: NonEmptyString;
- /**
- * The protocol to use when redirecting requests. By default, this field uses the same protocol as the original request. Valid values are http or https.
- */
- Protocol?: NonEmptyString;
- }
- export interface AwsS3BucketWebsiteConfigurationRoutingRule {
- /**
- * Provides the condition that must be met in order to apply the routing rule.
- */
- Condition?: AwsS3BucketWebsiteConfigurationRoutingRuleCondition;
- /**
- * Provides the rules to redirect the request if the condition in Condition is met.
- */
- Redirect?: AwsS3BucketWebsiteConfigurationRoutingRuleRedirect;
- }
- export interface AwsS3BucketWebsiteConfigurationRoutingRuleCondition {
- /**
- * Indicates to redirect the request if the HTTP error code matches this value.
- */
- HttpErrorCodeReturnedEquals?: NonEmptyString;
- /**
- * Indicates to redirect the request if the key prefix matches this value.
- */
- KeyPrefixEquals?: NonEmptyString;
- }
- export interface AwsS3BucketWebsiteConfigurationRoutingRuleRedirect {
- /**
- * The host name to use in the redirect request.
- */
- Hostname?: NonEmptyString;
- /**
- * The HTTP redirect code to use in the response.
- */
- HttpRedirectCode?: NonEmptyString;
- /**
- * The protocol to use to redirect the request. By default, uses the protocol from the original request.
- */
- Protocol?: NonEmptyString;
- /**
- * The object key prefix to use in the redirect request. Cannot be provided if ReplaceKeyWith is present.
- */
- ReplaceKeyPrefixWith?: NonEmptyString;
- /**
- * The specific object key to use in the redirect request. Cannot be provided if ReplaceKeyPrefixWith is present.
- */
- ReplaceKeyWith?: NonEmptyString;
- }
- export type AwsS3BucketWebsiteConfigurationRoutingRules = AwsS3BucketWebsiteConfigurationRoutingRule[];
- export interface AwsS3ObjectDetails {
- /**
- * Indicates when the object was last modified. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastModified?: NonEmptyString;
- /**
- * The opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- */
- ETag?: NonEmptyString;
- /**
- * The version of the object.
- */
- VersionId?: NonEmptyString;
- /**
- * A standard MIME type describing the format of the object data.
- */
- ContentType?: NonEmptyString;
- /**
- * If the object is stored using server-side encryption, the value of the server-side encryption algorithm used when storing this object in Amazon S3.
- */
- ServerSideEncryption?: NonEmptyString;
- /**
- * The identifier of the KMS symmetric customer managed key that was used for the object.
- */
- SSEKMSKeyId?: NonEmptyString;
- }
- export interface AwsSageMakerNotebookInstanceDetails {
- /**
- * A list of Amazon Elastic Inference instance types to associate with the notebook instance. Currently, only one instance type can be associated with a notebook instance.
- */
- AcceleratorTypes?: NonEmptyStringList;
- /**
- * An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.
- */
- AdditionalCodeRepositories?: NonEmptyStringList;
- /**
- * The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git repositories with SageMaker notebook instances in the Amazon SageMaker Developer Guide.
- */
- DefaultCodeRepository?: NonEmptyString;
- /**
- * Sets whether SageMaker provides internet access to the notebook instance. If you set this to Disabled, this notebook instance is able to access resources only in your VPC, and is not be able to connect to SageMaker training and endpoint services unless you configure a Network Address Translation (NAT) Gateway in your VPC.
- */
- DirectInternetAccess?: NonEmptyString;
- /**
- * If status of the instance is Failed, the reason it failed.
- */
- FailureReason?: NonEmptyString;
- /**
- * Information on the IMDS configuration of the notebook instance.
- */
- InstanceMetadataServiceConfiguration?: AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails;
- /**
- * The type of machine learning (ML) compute instance to launch for the notebook instance.
- */
- InstanceType?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of an Key Management Service (KMS) key that SageMaker uses to encrypt data on the storage volume attached to your notebook instance. The KMS key you provide must be enabled. For information, see Enabling and disabling keys in the Key Management Service Developer Guide.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * The network interface ID that SageMaker created when the instance was created.
- */
- NetworkInterfaceId?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the notebook instance.
- */
- NotebookInstanceArn?: NonEmptyString;
- /**
- * The name of a notebook instance lifecycle configuration.
- */
- NotebookInstanceLifecycleConfigName?: NonEmptyString;
- /**
- * The name of the new notebook instance.
- */
- NotebookInstanceName?: NonEmptyString;
- /**
- * The status of the notebook instance.
- */
- NotebookInstanceStatus?: NonEmptyString;
- /**
- * The platform identifier of the notebook instance runtime environment.
- */
- PlatformIdentifier?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the IAM role associated with the instance.
- */
- RoleArn?: NonEmptyString;
- /**
- * Whether root access is enabled or disabled for users of the notebook instance.
- */
- RootAccess?: NonEmptyString;
- /**
- * The VPC security group IDs.
- */
- SecurityGroups?: NonEmptyStringList;
- /**
- * The ID of the VPC subnet to which you have a connectivity from your ML compute instance.
- */
- SubnetId?: NonEmptyString;
- /**
- * The URL that you use to connect to the Jupyter notebook that is running in your notebook instance.
- */
- Url?: NonEmptyString;
- /**
- * The size, in GB, of the ML storage volume to attach to the notebook instance.
- */
- VolumeSizeInGB?: Integer;
- }
- export interface AwsSageMakerNotebookInstanceMetadataServiceConfigurationDetails {
- /**
- * Indicates the minimum IMDS version that the notebook instance supports.
- */
- MinimumInstanceMetadataServiceVersion?: NonEmptyString;
- }
- export interface AwsSecretsManagerSecretDetails {
- /**
- * Defines the rotation schedule for the secret.
- */
- RotationRules?: AwsSecretsManagerSecretRotationRules;
- /**
- * Whether the rotation occurred within the specified rotation frequency.
- */
- RotationOccurredWithinFrequency?: Boolean;
- /**
- * The ARN, Key ID, or alias of the KMS key used to encrypt the SecretString or SecretBinary values for versions of this secret.
- */
- KmsKeyId?: NonEmptyString;
- /**
- * Whether rotation is enabled.
- */
- RotationEnabled?: Boolean;
- /**
- * The ARN of the Lambda function that rotates the secret.
- */
- RotationLambdaArn?: NonEmptyString;
- /**
- * Whether the secret is deleted.
- */
- Deleted?: Boolean;
- /**
- * The name of the secret.
- */
- Name?: NonEmptyString;
- /**
- * The user-provided description of the secret.
- */
- Description?: NonEmptyString;
- }
- export interface AwsSecretsManagerSecretRotationRules {
- /**
- * The number of days after the previous rotation to rotate the secret.
- */
- AutomaticallyAfterDays?: Integer;
- }
- export interface AwsSecurityFinding {
- /**
- * The schema version that a finding is formatted for.
- */
- SchemaVersion: NonEmptyString;
- /**
- * The security findings provider-specific identifier for a finding.
- */
- Id: NonEmptyString;
- /**
- * The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
- */
- ProductArn: NonEmptyString;
- /**
- * The name of the product that generated the finding. Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration. When you use the Security Hub console or API to filter findings by product name, you use this attribute.
- */
- ProductName?: NonEmptyString;
- /**
- * The name of the company for the product that generated the finding. Security Hub populates this attribute automatically for each finding. You cannot update this attribute with BatchImportFindings or BatchUpdateFindings. The exception to this is a custom integration. When you use the Security Hub console or API to filter findings by company name, you use this attribute.
- */
- CompanyName?: NonEmptyString;
- /**
- * The Region from which the finding was generated. Security Hub populates this attribute automatically for each finding. You cannot update it using BatchImportFindings or BatchUpdateFindings.
- */
- Region?: NonEmptyString;
- /**
- * The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
- */
- GeneratorId: NonEmptyString;
- /**
- * The Amazon Web Services account ID that a finding is generated in.
- */
- AwsAccountId: NonEmptyString;
- /**
- * One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
- */
- Types?: TypeList;
- /**
- * Indicates when the security findings provider first observed the potential security issue that a finding captured. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- FirstObservedAt?: NonEmptyString;
- /**
- * Indicates when the security findings provider most recently observed the potential security issue that a finding captured. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastObservedAt?: NonEmptyString;
- /**
- * Indicates when the security findings provider created the potential security issue that a finding captured. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt: NonEmptyString;
- /**
- * Indicates when the security findings provider last updated the finding record. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt: NonEmptyString;
- /**
- * A finding's severity.
- */
- Severity?: Severity;
- /**
- * A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- */
- Confidence?: Integer;
- /**
- * The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- */
- Criticality?: Integer;
- /**
- * A finding's title. In this release, Title is a required property.
- */
- Title: NonEmptyString;
- /**
- * A finding's description. In this release, Description is a required property.
- */
- Description: NonEmptyString;
- /**
- * A data type that describes the remediation options for a finding.
- */
- Remediation?: Remediation;
- /**
- * A URL that links to a page about the current finding in the security findings provider's solution.
- */
- SourceUrl?: NonEmptyString;
- /**
- * A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format. Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 2048 characters.
- */
- ProductFields?: FieldMap;
- /**
- * A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
- */
- UserDefinedFields?: FieldMap;
- /**
- * A list of malware related to a finding.
- */
- Malware?: MalwareList;
- /**
- * The details of network-related information about a finding.
- */
- Network?: Network;
- /**
- * Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.
- */
- NetworkPath?: NetworkPathList;
- /**
- * The details of process-related information about a finding.
- */
- Process?: ProcessDetails;
- /**
- * Details about the threat detected in a security finding and the file paths that were affected by the threat.
- */
- Threats?: ThreatList;
- /**
- * Threat intelligence details related to a finding.
- */
- ThreatIntelIndicators?: ThreatIntelIndicatorList;
- /**
- * A set of resource data types that describe the resources that the finding refers to.
- */
- Resources: ResourceList;
- /**
- * This data type is exclusive to findings that are generated as the result of a check run against a specific rule in a supported security standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
- */
- Compliance?: Compliance;
- /**
- * Indicates the veracity of a finding.
- */
- VerificationState?: VerificationState;
- /**
- * The workflow state of a finding.
- */
- WorkflowState?: WorkflowState;
- /**
- * Provides information about the status of the investigation into a finding.
- */
- Workflow?: Workflow;
- /**
- * The record state of a finding.
- */
- RecordState?: RecordState;
- /**
- * A list of related findings.
- */
- RelatedFindings?: RelatedFindingList;
- /**
- * A user-defined note added to a finding.
- */
- Note?: Note;
- /**
- * Provides a list of vulnerabilities associated with the findings.
- */
- Vulnerabilities?: VulnerabilityList;
- /**
- * Provides an overview of the patch compliance status for an instance against a selected compliance standard.
- */
- PatchSummary?: PatchSummary;
- /**
- * Provides details about an action that affects or that was taken on a resource.
- */
- Action?: Action;
- /**
- * In a BatchImportFindings request, finding providers use FindingProviderFields to provide and update their own values for confidence, criticality, related findings, severity, and types.
- */
- FindingProviderFields?: FindingProviderFields;
- /**
- * Indicates whether the finding is a sample finding.
- */
- Sample?: Boolean;
- /**
- * Provides metadata for the Amazon CodeGuru detector associated with a finding. This field pertains to findings that relate to Lambda functions. Amazon Inspector identifies policy violations and vulnerabilities in Lambda function code based on internal detectors developed in collaboration with Amazon CodeGuru. Security Hub receives those findings.
- */
- GeneratorDetails?: GeneratorDetails;
- /**
- * A imestamp that indicates when Security Hub received a finding and begins to process it. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ProcessedAt?: NonEmptyString;
- /**
- * The name of the Amazon Web Services account from which a finding was generated.
- */
- AwsAccountName?: NonEmptyString;
- }
- export interface AwsSecurityFindingFilters {
- /**
- * The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
- */
- ProductArn?: StringFilterList;
- /**
- * The Amazon Web Services account ID in which a finding is generated.
- */
- AwsAccountId?: StringFilterList;
- /**
- * The security findings provider-specific identifier for a finding.
- */
- Id?: StringFilterList;
- /**
- * The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
- */
- GeneratorId?: StringFilterList;
- /**
- * The Region from which the finding was generated.
- */
- Region?: StringFilterList;
- /**
- * A finding type in the format of namespace/category/classifier that classifies a finding.
- */
- Type?: StringFilterList;
- /**
- * A timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- FirstObservedAt?: DateFilterList;
- /**
- * A timestamp that indicates when the security findings provider most recently observed the potential security issue that a finding captured. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastObservedAt?: DateFilterList;
- /**
- * A timestamp that indicates when the security findings provider created the potential security issue that a finding reflects. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- CreatedAt?: DateFilterList;
- /**
- * A timestamp that indicates when the security findings provider last updated the finding record. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt?: DateFilterList;
- /**
- * The native severity as defined by the security findings provider's solution that generated the finding.
- */
- SeverityProduct?: NumberFilterList;
- /**
- * The normalized severity of a finding.
- */
- SeverityNormalized?: NumberFilterList;
- /**
- * The label of a finding's severity.
- */
- SeverityLabel?: StringFilterList;
- /**
- * A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- */
- Confidence?: NumberFilterList;
- /**
- * The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- */
- Criticality?: NumberFilterList;
- /**
- * A finding's title.
- */
- Title?: StringFilterList;
- /**
- * A finding's description.
- */
- Description?: StringFilterList;
- /**
- * The recommendation of what to do about the issue described in a finding.
- */
- RecommendationText?: StringFilterList;
- /**
- * A URL that links to a page about the current finding in the security findings provider's solution.
- */
- SourceUrl?: StringFilterList;
- /**
- * A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
- */
- ProductFields?: MapFilterList;
- /**
- * The name of the solution (product) that generates findings.
- */
- ProductName?: StringFilterList;
- /**
- * The name of the findings provider (company) that owns the solution (product) that generates findings.
- */
- CompanyName?: StringFilterList;
- /**
- * A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
- */
- UserDefinedFields?: MapFilterList;
- /**
- * The name of the malware that was observed.
- */
- MalwareName?: StringFilterList;
- /**
- * The type of the malware that was observed.
- */
- MalwareType?: StringFilterList;
- /**
- * The filesystem path of the malware that was observed.
- */
- MalwarePath?: StringFilterList;
- /**
- * The state of the malware that was observed.
- */
- MalwareState?: StringFilterList;
- /**
- * Indicates the direction of network traffic associated with a finding.
- */
- NetworkDirection?: StringFilterList;
- /**
- * The protocol of network-related information about a finding.
- */
- NetworkProtocol?: StringFilterList;
- /**
- * The source IPv4 address of network-related information about a finding.
- */
- NetworkSourceIpV4?: IpFilterList;
- /**
- * The source IPv6 address of network-related information about a finding.
- */
- NetworkSourceIpV6?: IpFilterList;
- /**
- * The source port of network-related information about a finding.
- */
- NetworkSourcePort?: NumberFilterList;
- /**
- * The source domain of network-related information about a finding.
- */
- NetworkSourceDomain?: StringFilterList;
- /**
- * The source media access control (MAC) address of network-related information about a finding.
- */
- NetworkSourceMac?: StringFilterList;
- /**
- * The destination IPv4 address of network-related information about a finding.
- */
- NetworkDestinationIpV4?: IpFilterList;
- /**
- * The destination IPv6 address of network-related information about a finding.
- */
- NetworkDestinationIpV6?: IpFilterList;
- /**
- * The destination port of network-related information about a finding.
- */
- NetworkDestinationPort?: NumberFilterList;
- /**
- * The destination domain of network-related information about a finding.
- */
- NetworkDestinationDomain?: StringFilterList;
- /**
- * The name of the process.
- */
- ProcessName?: StringFilterList;
- /**
- * The path to the process executable.
- */
- ProcessPath?: StringFilterList;
- /**
- * The process ID.
- */
- ProcessPid?: NumberFilterList;
- /**
- * The parent process ID. This field accepts positive integers between O and 2147483647.
- */
- ProcessParentPid?: NumberFilterList;
- /**
- * A timestamp that identifies when the process was launched. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ProcessLaunchedAt?: DateFilterList;
- /**
- * A timestamp that identifies when the process was terminated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ProcessTerminatedAt?: DateFilterList;
- /**
- * The type of a threat intelligence indicator.
- */
- ThreatIntelIndicatorType?: StringFilterList;
- /**
- * The value of a threat intelligence indicator.
- */
- ThreatIntelIndicatorValue?: StringFilterList;
- /**
- * The category of a threat intelligence indicator.
- */
- ThreatIntelIndicatorCategory?: StringFilterList;
- /**
- * A timestamp that identifies the last observation of a threat intelligence indicator.
- */
- ThreatIntelIndicatorLastObservedAt?: DateFilterList;
- /**
- * The source of the threat intelligence.
- */
- ThreatIntelIndicatorSource?: StringFilterList;
- /**
- * The URL for more details from the source of the threat intelligence.
- */
- ThreatIntelIndicatorSourceUrl?: StringFilterList;
- /**
- * Specifies the type of the resource that details are provided for.
- */
- ResourceType?: StringFilterList;
- /**
- * The canonical identifier for the given resource type.
- */
- ResourceId?: StringFilterList;
- /**
- * The canonical Amazon Web Services partition name that the Region is assigned to.
- */
- ResourcePartition?: StringFilterList;
- /**
- * The canonical Amazon Web Services external Region name where this resource is located.
- */
- ResourceRegion?: StringFilterList;
- /**
- * A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
- */
- ResourceTags?: MapFilterList;
- /**
- * The instance type of the instance.
- */
- ResourceAwsEc2InstanceType?: StringFilterList;
- /**
- * The Amazon Machine Image (AMI) ID of the instance.
- */
- ResourceAwsEc2InstanceImageId?: StringFilterList;
- /**
- * The IPv4 addresses associated with the instance.
- */
- ResourceAwsEc2InstanceIpV4Addresses?: IpFilterList;
- /**
- * The IPv6 addresses associated with the instance.
- */
- ResourceAwsEc2InstanceIpV6Addresses?: IpFilterList;
- /**
- * The key name associated with the instance.
- */
- ResourceAwsEc2InstanceKeyName?: StringFilterList;
- /**
- * The IAM profile ARN of the instance.
- */
- ResourceAwsEc2InstanceIamInstanceProfileArn?: StringFilterList;
- /**
- * The identifier of the VPC that the instance was launched in.
- */
- ResourceAwsEc2InstanceVpcId?: StringFilterList;
- /**
- * The identifier of the subnet that the instance was launched in.
- */
- ResourceAwsEc2InstanceSubnetId?: StringFilterList;
- /**
- * The date and time the instance was launched.
- */
- ResourceAwsEc2InstanceLaunchedAt?: DateFilterList;
- /**
- * The canonical user ID of the owner of the S3 bucket.
- */
- ResourceAwsS3BucketOwnerId?: StringFilterList;
- /**
- * The display name of the owner of the S3 bucket.
- */
- ResourceAwsS3BucketOwnerName?: StringFilterList;
- /**
- * The user associated with the IAM access key related to a finding.
- */
- ResourceAwsIamAccessKeyUserName?: StringFilterList;
- /**
- * The name of the principal that is associated with an IAM access key.
- */
- ResourceAwsIamAccessKeyPrincipalName?: StringFilterList;
- /**
- * The status of the IAM access key related to a finding.
- */
- ResourceAwsIamAccessKeyStatus?: StringFilterList;
- /**
- * The creation date/time of the IAM access key related to a finding.
- */
- ResourceAwsIamAccessKeyCreatedAt?: DateFilterList;
- /**
- * The name of an IAM user.
- */
- ResourceAwsIamUserUserName?: StringFilterList;
- /**
- * The name of the container related to a finding.
- */
- ResourceContainerName?: StringFilterList;
- /**
- * The identifier of the image related to a finding.
- */
- ResourceContainerImageId?: StringFilterList;
- /**
- * The name of the image related to a finding.
- */
- ResourceContainerImageName?: StringFilterList;
- /**
- * A timestamp that identifies when the container was started. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- ResourceContainerLaunchedAt?: DateFilterList;
- /**
- * The details of a resource that doesn't have a specific subfield for the resource type defined.
- */
- ResourceDetailsOther?: MapFilterList;
- /**
- * Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
- */
- ComplianceStatus?: StringFilterList;
- /**
- * The veracity of a finding.
- */
- VerificationState?: StringFilterList;
- /**
- * The workflow state of a finding. Note that this field is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.
- */
- WorkflowState?: StringFilterList;
- /**
- * The status of the investigation into a finding. Allowed values are the following. NEW - The initial state of a finding, before it is reviewed. Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases: RecordState changes from ARCHIVED to ACTIVE. Compliance.Status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE. NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. If one of the following occurs, the workflow status is changed automatically from NOTIFIED to NEW: RecordState changes from ARCHIVED to ACTIVE. Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE. SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The workflow status of a SUPPRESSED finding does not change if RecordState changes from ARCHIVED to ACTIVE. RESOLVED - The finding was reviewed and remediated and is now considered resolved. The finding remains RESOLVED unless one of the following occurs: RecordState changes from ARCHIVED to ACTIVE. Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE. In those cases, the workflow status is automatically reset to NEW. For findings from controls, if Compliance.Status is PASSED, then Security Hub automatically sets the workflow status to RESOLVED.
- */
- WorkflowStatus?: StringFilterList;
- /**
- * The updated record state for the finding.
- */
- RecordState?: StringFilterList;
- /**
- * The ARN of the solution that generated a related finding.
- */
- RelatedFindingsProductArn?: StringFilterList;
- /**
- * The solution-generated identifier for a related finding.
- */
- RelatedFindingsId?: StringFilterList;
- /**
- * The text of a note.
- */
- NoteText?: StringFilterList;
- /**
- * The timestamp of when the note was updated.
- */
- NoteUpdatedAt?: DateFilterList;
- /**
- * The principal that created a note.
- */
- NoteUpdatedBy?: StringFilterList;
- /**
- * A keyword for a finding.
- */
- Keyword?: KeywordFilterList;
- /**
- * The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- */
- FindingProviderFieldsConfidence?: NumberFilterList;
- /**
- * The finding provider value for the level of importance assigned to the resources associated with the findings. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- */
- FindingProviderFieldsCriticality?: NumberFilterList;
- /**
- * The finding identifier of a related finding that is identified by the finding provider.
- */
- FindingProviderFieldsRelatedFindingsId?: StringFilterList;
- /**
- * The ARN of the solution that generated a related finding that is identified by the finding provider.
- */
- FindingProviderFieldsRelatedFindingsProductArn?: StringFilterList;
- /**
- * The finding provider value for the severity label.
- */
- FindingProviderFieldsSeverityLabel?: StringFilterList;
- /**
- * The finding provider's original value for the severity.
- */
- FindingProviderFieldsSeverityOriginal?: StringFilterList;
- /**
- * One or more finding types that the finding provider assigned to the finding. Uses the format of namespace/category/classifier that classify a finding. Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
- */
- FindingProviderFieldsTypes?: StringFilterList;
- /**
- * Indicates whether or not sample findings are included in the filter results.
- */
- Sample?: BooleanFilterList;
- /**
- * The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.
- */
- ComplianceSecurityControlId?: StringFilterList;
- /**
- * The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
- */
- ComplianceAssociatedStandardsId?: StringFilterList;
- /**
- * Indicates whether a software vulnerability in your environment has a known exploit. You can filter findings by this field only if you use Security Hub and Amazon Inspector.
- */
- VulnerabilitiesExploitAvailable?: StringFilterList;
- /**
- * Indicates whether a vulnerability is fixed in a newer version of the affected software packages. You can filter findings by this field only if you use Security Hub and Amazon Inspector.
- */
- VulnerabilitiesFixAvailable?: StringFilterList;
- /**
- * The name of a security control parameter.
- */
- ComplianceSecurityControlParametersName?: StringFilterList;
- /**
- * The current value of a security control parameter.
- */
- ComplianceSecurityControlParametersValue?: StringFilterList;
- /**
- * The name of the Amazon Web Services account in which a finding is generated.
- */
- AwsAccountName?: StringFilterList;
- /**
- * The name of the application that is related to a finding.
- */
- ResourceApplicationName?: StringFilterList;
- /**
- * The ARN of the application that is related to a finding.
- */
- ResourceApplicationArn?: StringFilterList;
- }
- export interface AwsSecurityFindingIdentifier {
- /**
- * The identifier of the finding that was specified by the finding provider.
- */
- Id: NonEmptyString;
- /**
- * The ARN generated by Security Hub that uniquely identifies a product that generates findings. This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for a custom integration.
- */
- ProductArn: NonEmptyString;
- }
- export type AwsSecurityFindingIdentifierList = AwsSecurityFindingIdentifier[];
- export type AwsSecurityFindingList = AwsSecurityFinding[];
- export interface AwsSnsTopicDetails {
- /**
- * The ID of an Amazon Web Services managed key for Amazon SNS or a customer managed key.
- */
- KmsMasterKeyId?: NonEmptyString;
- /**
- * Subscription is an embedded property that describes the subscription endpoints of an Amazon SNS topic.
- */
- Subscription?: AwsSnsTopicSubscriptionList;
- /**
- * The name of the Amazon SNS topic.
- */
- TopicName?: NonEmptyString;
- /**
- * The subscription's owner.
- */
- Owner?: NonEmptyString;
- /**
- * Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
- */
- SqsSuccessFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
- */
- SqsFailureFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
- */
- ApplicationSuccessFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
- */
- FirehoseSuccessFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
- */
- FirehoseFailureFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
- */
- HttpSuccessFeedbackRoleArn?: NonEmptyString;
- /**
- * Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
- */
- HttpFailureFeedbackRoleArn?: NonEmptyString;
- }
- export interface AwsSnsTopicSubscription {
- /**
- * The subscription's endpoint (format depends on the protocol).
- */
- Endpoint?: NonEmptyString;
- /**
- * The subscription's protocol.
- */
- Protocol?: NonEmptyString;
- }
- export type AwsSnsTopicSubscriptionList = AwsSnsTopicSubscription[];
- export interface AwsSqsQueueDetails {
- /**
- * The length of time, in seconds, for which Amazon SQS can reuse a data key to encrypt or decrypt messages before calling KMS again.
- */
- KmsDataKeyReusePeriodSeconds?: Integer;
- /**
- * The ID of an Amazon Web Services managed key for Amazon SQS or a custom KMS key.
- */
- KmsMasterKeyId?: NonEmptyString;
- /**
- * The name of the new queue.
- */
- QueueName?: NonEmptyString;
- /**
- * The ARN of the dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.
- */
- DeadLetterTargetArn?: NonEmptyString;
- }
- export interface AwsSsmComplianceSummary {
- /**
- * The current patch compliance status. Valid values are as follows: COMPLIANT NON_COMPLIANT UNSPECIFIED_DATA
- */
- Status?: NonEmptyString;
- /**
- * For the patches that are compliant, the number that have a severity of CRITICAL.
- */
- CompliantCriticalCount?: Integer;
- /**
- * For the patches that are compliant, the number that have a severity of HIGH.
- */
- CompliantHighCount?: Integer;
- /**
- * For the patches that are compliant, the number that have a severity of MEDIUM.
- */
- CompliantMediumCount?: Integer;
- /**
- * The type of execution that was used determine compliance.
- */
- ExecutionType?: NonEmptyString;
- /**
- * For the patch items that are noncompliant, the number of items that have a severity of CRITICAL.
- */
- NonCompliantCriticalCount?: Integer;
- /**
- * For the patches that are compliant, the number that have a severity of INFORMATIONAL.
- */
- CompliantInformationalCount?: Integer;
- /**
- * For the patches that are noncompliant, the number that have a severity of INFORMATIONAL.
- */
- NonCompliantInformationalCount?: Integer;
- /**
- * For the patches that are compliant, the number that have a severity of UNSPECIFIED.
- */
- CompliantUnspecifiedCount?: Integer;
- /**
- * For the patches that are noncompliant, the number that have a severity of LOW.
- */
- NonCompliantLowCount?: Integer;
- /**
- * For the patches that are noncompliant, the number that have a severity of HIGH.
- */
- NonCompliantHighCount?: Integer;
- /**
- * For the patches that are compliant, the number that have a severity of LOW.
- */
- CompliantLowCount?: Integer;
- /**
- * The type of resource for which the compliance was determined. For AwsSsmPatchCompliance, ComplianceType is Patch.
- */
- ComplianceType?: NonEmptyString;
- /**
- * The identifier of the patch baseline. The patch baseline lists the patches that are approved for installation.
- */
- PatchBaselineId?: NonEmptyString;
- /**
- * The highest severity for the patches. Valid values are as follows: CRITICAL HIGH MEDIUM LOW INFORMATIONAL UNSPECIFIED
- */
- OverallSeverity?: NonEmptyString;
- /**
- * For the patches that are noncompliant, the number that have a severity of MEDIUM.
- */
- NonCompliantMediumCount?: Integer;
- /**
- * For the patches that are noncompliant, the number that have a severity of UNSPECIFIED.
- */
- NonCompliantUnspecifiedCount?: Integer;
- /**
- * The identifier of the patch group for which compliance was determined. A patch group uses tags to group EC2 instances that should have the same patch compliance.
- */
- PatchGroup?: NonEmptyString;
- }
- export interface AwsSsmPatch {
- /**
- * The compliance status details for the patch.
- */
- ComplianceSummary?: AwsSsmComplianceSummary;
- }
- export interface AwsSsmPatchComplianceDetails {
- /**
- * Information about the status of a patch.
- */
- Patch?: AwsSsmPatch;
- }
- export interface AwsStepFunctionStateMachineDetails {
- /**
- * A user-defined or an auto-generated string that identifies a Map state. This parameter is present only if the stateMachineArn specified in input is a qualified state machine ARN.
- */
- Label?: NonEmptyString;
- /**
- * Used to set CloudWatch Logs options.
- */
- LoggingConfiguration?: AwsStepFunctionStateMachineLoggingConfigurationDetails;
- /**
- * The name of the state machine.
- */
- Name?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the IAM role used when creating this state machine.
- */
- RoleArn?: NonEmptyString;
- /**
- * The ARN that identifies the state machine.
- */
- StateMachineArn?: NonEmptyString;
- /**
- * The current status of the state machine.
- */
- Status?: NonEmptyString;
- /**
- * Specifies whether X-Ray tracing is enabled.
- */
- TracingConfiguration?: AwsStepFunctionStateMachineTracingConfigurationDetails;
- /**
- * The type of the state machine (STANDARD or EXPRESS).
- */
- Type?: NonEmptyString;
- }
- export interface AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails {
- /**
- * The ARN (ends with :*) of the CloudWatch Logs log group to which you want your logs emitted.
- */
- LogGroupArn?: NonEmptyString;
- }
- export interface AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails {
- /**
- * An object describing a CloudWatch Logs log group. For more information, see Amazon Web Services::Logs::LogGroup in the CloudFormation User Guide.
- */
- CloudWatchLogsLogGroup?: AwsStepFunctionStateMachineLoggingConfigurationDestinationsCloudWatchLogsLogGroupDetails;
- }
- export type AwsStepFunctionStateMachineLoggingConfigurationDestinationsList = AwsStepFunctionStateMachineLoggingConfigurationDestinationsDetails[];
- export interface AwsStepFunctionStateMachineLoggingConfigurationDetails {
- /**
- * An array of objects that describes where your execution history events will be logged.
- */
- Destinations?: AwsStepFunctionStateMachineLoggingConfigurationDestinationsList;
- /**
- * Determines whether execution data is included in your log. When set to false, data is excluded.
- */
- IncludeExecutionData?: Boolean;
- /**
- * Defines which category of execution history events are logged.
- */
- Level?: NonEmptyString;
- }
- export interface AwsStepFunctionStateMachineTracingConfigurationDetails {
- /**
- * When set to true, X-Ray tracing is enabled.
- */
- Enabled?: Boolean;
- }
- export interface AwsWafRateBasedRuleDetails {
- /**
- * The name of the metrics for the rate-based rule.
- */
- MetricName?: NonEmptyString;
- /**
- * The name of the rate-based rule.
- */
- Name?: NonEmptyString;
- /**
- * The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
- */
- RateKey?: NonEmptyString;
- /**
- * The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.
- */
- RateLimit?: Long;
- /**
- * The unique identifier for the rate-based rule.
- */
- RuleId?: NonEmptyString;
- /**
- * The predicates to include in the rate-based rule.
- */
- MatchPredicates?: AwsWafRateBasedRuleMatchPredicateList;
- }
- export interface AwsWafRateBasedRuleMatchPredicate {
- /**
- * The unique identifier for the predicate.
- */
- DataId?: NonEmptyString;
- /**
- * If set to true, then the rule actions are performed on requests that match the predicate settings. If set to false, then the rule actions are performed on all requests except those that match the predicate settings.
- */
- Negated?: Boolean;
- /**
- * The type of predicate. Valid values are as follows: ByteMatch GeoMatch IPMatch RegexMatch SizeConstraint SqlInjectionMatch XssMatch
- */
- Type?: NonEmptyString;
- }
- export type AwsWafRateBasedRuleMatchPredicateList = AwsWafRateBasedRuleMatchPredicate[];
- export interface AwsWafRegionalRateBasedRuleDetails {
- /**
- * The name of the metrics for the rate-based rule.
- */
- MetricName?: NonEmptyString;
- /**
- * The name of the rate-based rule.
- */
- Name?: NonEmptyString;
- /**
- * The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
- */
- RateKey?: NonEmptyString;
- /**
- * The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.
- */
- RateLimit?: Long;
- /**
- * The unique identifier for the rate-based rule.
- */
- RuleId?: NonEmptyString;
- /**
- * The predicates to include in the rate-based rule.
- */
- MatchPredicates?: AwsWafRegionalRateBasedRuleMatchPredicateList;
- }
- export interface AwsWafRegionalRateBasedRuleMatchPredicate {
- /**
- * The unique identifier for the predicate.
- */
- DataId?: NonEmptyString;
- /**
- * If set to true, then the rule actions are performed on requests that match the predicate settings. If set to false, then the rule actions are performed on all requests except those that match the predicate settings.
- */
- Negated?: Boolean;
- /**
- * The type of predicate. Valid values are as follows: ByteMatch GeoMatch IPMatch RegexMatch SizeConstraint SqlInjectionMatch XssMatch
- */
- Type?: NonEmptyString;
- }
- export type AwsWafRegionalRateBasedRuleMatchPredicateList = AwsWafRegionalRateBasedRuleMatchPredicate[];
- export interface AwsWafRegionalRuleDetails {
- /**
- * A name for the metrics for the rule.
- */
- MetricName?: NonEmptyString;
- /**
- * A descriptive name for the rule.
- */
- Name?: NonEmptyString;
- /**
- * Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.
- */
- PredicateList?: AwsWafRegionalRulePredicateList;
- /**
- * The ID of the rule.
- */
- RuleId?: NonEmptyString;
- }
- export interface AwsWafRegionalRuleGroupDetails {
- /**
- * A name for the metrics for this rule group.
- */
- MetricName?: NonEmptyString;
- /**
- * The descriptive name of the rule group.
- */
- Name?: NonEmptyString;
- /**
- * The ID of the rule group.
- */
- RuleGroupId?: NonEmptyString;
- /**
- * Provides information about the rule statements used to identify the web requests that you want to allow, block, or count.
- */
- Rules?: AwsWafRegionalRuleGroupRulesList;
- }
- export interface AwsWafRegionalRuleGroupRulesActionDetails {
- /**
- * Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRegionalRuleGroupRulesDetails {
- /**
- * The action that WAF should take on a web request when it matches the criteria defined in the rule.
- */
- Action?: AwsWafRegionalRuleGroupRulesActionDetails;
- /**
- * If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the value of Priority.
- */
- Priority?: Integer;
- /**
- * The ID for a rule.
- */
- RuleId?: NonEmptyString;
- /**
- * The type of rule in the rule group.
- */
- Type?: NonEmptyString;
- }
- export type AwsWafRegionalRuleGroupRulesList = AwsWafRegionalRuleGroupRulesDetails[];
- export type AwsWafRegionalRulePredicateList = AwsWafRegionalRulePredicateListDetails[];
- export interface AwsWafRegionalRulePredicateListDetails {
- /**
- * A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.
- */
- DataId?: NonEmptyString;
- /**
- * Specifies if you want WAF to allow, block, or count requests based on the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.
- */
- Negated?: Boolean;
- /**
- * The type of predicate in a rule, such as ByteMatch or IPSet.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRegionalWebAclDetails {
- /**
- * The action to perform if none of the rules contained in the web ACL match.
- */
- DefaultAction?: NonEmptyString;
- /**
- * A name for the metrics for this web ACL.
- */
- MetricName?: NonEmptyString;
- /**
- * A descriptive name for the web ACL.
- */
- Name?: NonEmptyString;
- /**
- * An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.
- */
- RulesList?: AwsWafRegionalWebAclRulesList;
- /**
- * The ID of the web ACL.
- */
- WebAclId?: NonEmptyString;
- }
- export type AwsWafRegionalWebAclRulesList = AwsWafRegionalWebAclRulesListDetails[];
- export interface AwsWafRegionalWebAclRulesListActionDetails {
- /**
- * For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRegionalWebAclRulesListDetails {
- /**
- * The action that WAF takes when a web request matches all conditions in the rule, such as allow, block, or count the request.
- */
- Action?: AwsWafRegionalWebAclRulesListActionDetails;
- /**
- * Overrides the rule evaluation result in the rule group.
- */
- OverrideAction?: AwsWafRegionalWebAclRulesListOverrideActionDetails;
- /**
- * The order in which WAF evaluates the rules in a web ACL.
- */
- Priority?: Integer;
- /**
- * The ID of an WAF Regional rule to associate with a web ACL.
- */
- RuleId?: NonEmptyString;
- /**
- * For actions that are associated with a rule, the action that WAF takes when a web request matches all conditions in a rule.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRegionalWebAclRulesListOverrideActionDetails {
- /**
- * Overrides the rule evaluation result in the rule group.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRuleDetails {
- /**
- * The name of the metrics for this rule.
- */
- MetricName?: NonEmptyString;
- /**
- * A descriptive name for the rule.
- */
- Name?: NonEmptyString;
- /**
- * Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.
- */
- PredicateList?: AwsWafRulePredicateList;
- /**
- * The ID of the WAF rule.
- */
- RuleId?: NonEmptyString;
- }
- export interface AwsWafRuleGroupDetails {
- /**
- * The name of the metrics for this rule group.
- */
- MetricName?: NonEmptyString;
- /**
- * The name of the rule group.
- */
- Name?: NonEmptyString;
- /**
- * The ID of the rule group.
- */
- RuleGroupId?: NonEmptyString;
- /**
- * Provides information about the rules attached to the rule group. These rules identify the web requests that you want to allow, block, or count.
- */
- Rules?: AwsWafRuleGroupRulesList;
- }
- export interface AwsWafRuleGroupRulesActionDetails {
- /**
- * The action that WAF should take on a web request when it matches the rule's statement.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafRuleGroupRulesDetails {
- /**
- * Provides information about what action WAF should take on a web request when it matches the criteria defined in the rule.
- */
- Action?: AwsWafRuleGroupRulesActionDetails;
- /**
- * If you define more than one rule in a web ACL, WAF evaluates each request against the rules in order based on the value of Priority.
- */
- Priority?: Integer;
- /**
- * The rule ID for a rule.
- */
- RuleId?: NonEmptyString;
- /**
- * The type of rule.
- */
- Type?: NonEmptyString;
- }
- export type AwsWafRuleGroupRulesList = AwsWafRuleGroupRulesDetails[];
- export type AwsWafRulePredicateList = AwsWafRulePredicateListDetails[];
- export interface AwsWafRulePredicateListDetails {
- /**
- * A unique identifier for a predicate in a rule, such as ByteMatchSetId or IPSetId.
- */
- DataId?: NonEmptyString;
- /**
- * Specifies if you want WAF to allow, block, or count requests based on the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.
- */
- Negated?: Boolean;
- /**
- * The type of predicate in a rule, such as ByteMatch or IPSet.
- */
- Type?: NonEmptyString;
- }
- export interface AwsWafWebAclDetails {
- /**
- * A friendly name or description of the web ACL. You can't change the name of a web ACL after you create it.
- */
- Name?: NonEmptyString;
- /**
- * The action to perform if none of the rules contained in the web ACL match.
- */
- DefaultAction?: NonEmptyString;
- /**
- * An array that contains the action for each rule in a web ACL, the priority of the rule, and the ID of the rule.
- */
- Rules?: AwsWafWebAclRuleList;
- /**
- * A unique identifier for a web ACL.
- */
- WebAclId?: NonEmptyString;
- }
- export interface AwsWafWebAclRule {
- /**
- * Specifies the action that CloudFront or WAF takes when a web request matches the conditions in the rule.
- */
- Action?: WafAction;
- /**
- * Rules to exclude from a rule group.
- */
- ExcludedRules?: WafExcludedRuleList;
- /**
- * Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup blocks a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However, if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup then overrides any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests are counted. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a web ACL. In this case you do not use ActivatedRule Action. For all other update requests, ActivatedRule Action is used instead of ActivatedRule OverrideAction.
- */
- OverrideAction?: WafOverrideAction;
- /**
- * Specifies the order in which the rules in a web ACL are evaluated. Rules with a lower value for Priority are evaluated before rules with a higher value. The value must be a unique integer. If you add multiple rules to a web ACL, the values do not need to be consecutive.
- */
- Priority?: Integer;
- /**
- * The identifier for a rule.
- */
- RuleId?: NonEmptyString;
- /**
- * The rule type. Valid values: REGULAR | RATE_BASED | GROUP The default is REGULAR.
- */
- Type?: NonEmptyString;
- }
- export type AwsWafWebAclRuleList = AwsWafWebAclRule[];
- export interface AwsWafv2ActionAllowDetails {
- /**
- * Defines custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide..
- */
- CustomRequestHandling?: AwsWafv2CustomRequestHandlingDetails;
- }
- export interface AwsWafv2ActionBlockDetails {
- /**
- * Defines a custom response for the web request. For information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
- */
- CustomResponse?: AwsWafv2CustomResponseDetails;
- }
- export interface AwsWafv2CustomHttpHeader {
- /**
- * The name of the custom header.
- */
- Name?: NonEmptyString;
- /**
- * The value of the custom header.
- */
- Value?: NonEmptyString;
- }
- export interface AwsWafv2CustomRequestHandlingDetails {
- /**
- * The HTTP headers to insert into the request.
- */
- InsertHeaders?: AwsWafv2InsertHeadersList;
- }
- export interface AwsWafv2CustomResponseDetails {
- /**
- * References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block.
- */
- CustomResponseBodyKey?: NonEmptyString;
- /**
- * The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
- */
- ResponseCode?: Integer;
- /**
- * The HTTP headers to use in the response.
- */
- ResponseHeaders?: AwsWafv2InsertHeadersList;
- }
- export type AwsWafv2InsertHeadersList = AwsWafv2CustomHttpHeader[];
- export interface AwsWafv2RuleGroupDetails {
- /**
- * The web ACL capacity units (WCUs) required for this rule group.
- */
- Capacity?: Long;
- /**
- * A description of the rule group that helps with identification.
- */
- Description?: NonEmptyString;
- /**
- * A unique identifier for the rule group.
- */
- Id?: NonEmptyString;
- /**
- * The name of the rule group. You cannot change the name of a rule group after you create it.
- */
- Name?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the entity.
- */
- Arn?: NonEmptyString;
- /**
- * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
- */
- Rules?: AwsWafv2RulesList;
- /**
- * Specifies whether the rule group is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
- */
- Scope?: NonEmptyString;
- /**
- * Defines and enables Amazon CloudWatch metrics and web request sample collection.
- */
- VisibilityConfig?: AwsWafv2VisibilityConfigDetails;
- }
- export interface AwsWafv2RulesActionCaptchaDetails {
- /**
- * Defines custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
- */
- CustomRequestHandling?: AwsWafv2CustomRequestHandlingDetails;
- }
- export interface AwsWafv2RulesActionCountDetails {
- /**
- * Defines custom handling for the web request. For more information, see Customizing web requests and responses in WAF in the WAF Developer Guide..
- */
- CustomRequestHandling?: AwsWafv2CustomRequestHandlingDetails;
- }
- export interface AwsWafv2RulesActionDetails {
- /**
- * Instructs WAF to allow the web request.
- */
- Allow?: AwsWafv2ActionAllowDetails;
- /**
- * Instructs WAF to block the web request.
- */
- Block?: AwsWafv2ActionBlockDetails;
- /**
- * Instructs WAF to run a CAPTCHA check against the web request.
- */
- Captcha?: AwsWafv2RulesActionCaptchaDetails;
- /**
- * Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
- */
- Count?: AwsWafv2RulesActionCountDetails;
- }
- export interface AwsWafv2RulesDetails {
- /**
- * The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
- */
- Action?: AwsWafv2RulesActionDetails;
- /**
- * The name of the rule.
- */
- Name?: NonEmptyString;
- /**
- * The action to use in the place of the action that results from the rule group evaluation.
- */
- OverrideAction?: NonEmptyString;
- /**
- * If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
- */
- Priority?: Integer;
- /**
- * Defines and enables Amazon CloudWatch metrics and web request sample collection.
- */
- VisibilityConfig?: AwsWafv2VisibilityConfigDetails;
- }
- export type AwsWafv2RulesList = AwsWafv2RulesDetails[];
- export interface AwsWafv2VisibilityConfigDetails {
- /**
- * A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF metrics and dimensions in the WAF Developer Guide.
- */
- CloudWatchMetricsEnabled?: Boolean;
- /**
- * A name of the Amazon CloudWatch metric.
- */
- MetricName?: NonEmptyString;
- /**
- * A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
- */
- SampledRequestsEnabled?: Boolean;
- }
- export interface AwsWafv2WebAclActionDetails {
- /**
- * Specifies that WAF should allow requests by default.
- */
- Allow?: AwsWafv2ActionAllowDetails;
- /**
- * Specifies that WAF should block requests by default.
- */
- Block?: AwsWafv2ActionBlockDetails;
- }
- export interface AwsWafv2WebAclCaptchaConfigDetails {
- /**
- * Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle.
- */
- ImmunityTimeProperty?: AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails;
- }
- export interface AwsWafv2WebAclCaptchaConfigImmunityTimePropertyDetails {
- /**
- * The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by WAF.
- */
- ImmunityTime?: Long;
- }
- export interface AwsWafv2WebAclDetails {
- /**
- * The name of the web ACL.
- */
- Name?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
- */
- Arn?: NonEmptyString;
- /**
- * Indicates whether this web ACL is managed by Firewall Manager.
- */
- ManagedbyFirewallManager?: Boolean;
- /**
- * A unique identifier for the web ACL.
- */
- Id?: NonEmptyString;
- /**
- * The web ACL capacity units (WCUs) currently being used by this web ACL.
- */
- Capacity?: Long;
- /**
- * Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings.
- */
- CaptchaConfig?: AwsWafv2WebAclCaptchaConfigDetails;
- /**
- * The action to perform if none of the Rules contained in the web ACL match.
- */
- DefaultAction?: AwsWafv2WebAclActionDetails;
- /**
- * A description of the web ACL that helps with identification.
- */
- Description?: NonEmptyString;
- /**
- * The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
- */
- Rules?: AwsWafv2RulesList;
- /**
- * Defines and enables Amazon CloudWatch metrics and web request sample collection.
- */
- VisibilityConfig?: AwsWafv2VisibilityConfigDetails;
- }
- export interface AwsXrayEncryptionConfigDetails {
- /**
- * The identifier of the KMS key that is used for encryption. Provided if Type is KMS.
- */
- KeyId?: NonEmptyString;
- /**
- * The current status of the encryption configuration. Valid values are ACTIVE or UPDATING. When Status is equal to UPDATING, X-Ray might use both the old and new encryption.
- */
- Status?: NonEmptyString;
- /**
- * The type of encryption. KMS indicates that the encryption uses KMS keys. NONE indicates the default encryption.
- */
- Type?: NonEmptyString;
- }
- export interface BatchDeleteAutomationRulesRequest {
- /**
- * A list of Amazon Resource Names (ARNs) for the rules that are to be deleted.
- */
- AutomationRulesArns: AutomationRulesArnsList;
- }
- export interface BatchDeleteAutomationRulesResponse {
- /**
- * A list of properly processed rule ARNs.
- */
- ProcessedAutomationRules?: AutomationRulesArnsList;
- /**
- * A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't delete and why.
- */
- UnprocessedAutomationRules?: UnprocessedAutomationRulesList;
- }
- export interface BatchDisableStandardsRequest {
- /**
- * The ARNs of the standards subscriptions to disable.
- */
- StandardsSubscriptionArns: StandardsSubscriptionArns;
- }
- export interface BatchDisableStandardsResponse {
- /**
- * The details of the standards subscriptions that were disabled.
- */
- StandardsSubscriptions?: StandardsSubscriptions;
- }
- export interface BatchEnableStandardsRequest {
- /**
- * The list of standards checks to enable.
- */
- StandardsSubscriptionRequests: StandardsSubscriptionRequests;
- }
- export interface BatchEnableStandardsResponse {
- /**
- * The details of the standards subscriptions that were enabled.
- */
- StandardsSubscriptions?: StandardsSubscriptions;
- }
- export interface BatchGetAutomationRulesRequest {
- /**
- * A list of rule ARNs to get details for.
- */
- AutomationRulesArns: AutomationRulesArnsList;
- }
- export interface BatchGetAutomationRulesResponse {
- /**
- * A list of rule details for the provided rule ARNs.
- */
- Rules?: AutomationRulesConfigList;
- /**
- * A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't retrieve and why.
- */
- UnprocessedAutomationRules?: UnprocessedAutomationRulesList;
- }
- export interface BatchGetConfigurationPolicyAssociationsRequest {
- /**
- * Specifies one or more target account IDs, organizational unit (OU) IDs, or the root ID to retrieve associations for.
- */
- ConfigurationPolicyAssociationIdentifiers: ConfigurationPolicyAssociationsList;
- }
- export interface BatchGetConfigurationPolicyAssociationsResponse {
- /**
- * Describes associations for the target accounts, OUs, or the root.
- */
- ConfigurationPolicyAssociations?: ConfigurationPolicyAssociationList;
- /**
- * An array of configuration policy associations, one for each configuration policy association identifier, that was specified in the request but couldn’t be processed due to an error.
- */
- UnprocessedConfigurationPolicyAssociations?: UnprocessedConfigurationPolicyAssociationList;
- }
- export interface BatchGetSecurityControlsRequest {
- /**
- * A list of security controls (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters). The security control ID or Amazon Resource Name (ARN) is the same across standards.
- */
- SecurityControlIds: StringList;
- }
- export interface BatchGetSecurityControlsResponse {
- /**
- * An array that returns the identifier, Amazon Resource Name (ARN), and other details about a security control. The same information is returned whether the request includes SecurityControlId or SecurityControlArn.
- */
- SecurityControls: SecurityControls;
- /**
- * A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which details cannot be returned.
- */
- UnprocessedIds?: UnprocessedSecurityControls;
- }
- export interface BatchGetStandardsControlAssociationsRequest {
- /**
- * An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. This field is used to query the enablement status of a control in a specified standard. The security control ID or ARN is the same across standards.
- */
- StandardsControlAssociationIds: StandardsControlAssociationIds;
- }
- export interface BatchGetStandardsControlAssociationsResponse {
- /**
- * Provides the enablement status of a security control in a specified standard and other details for the control in relation to the specified standard.
- */
- StandardsControlAssociationDetails: StandardsControlAssociationDetails;
- /**
- * A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard cannot be returned.
- */
- UnprocessedAssociations?: UnprocessedStandardsControlAssociations;
- }
- export interface BatchImportFindingsRequest {
- /**
- * A list of findings to import. To successfully import a finding, it must follow the Amazon Web Services Security Finding Format. Maximum of 100 findings per request.
- */
- Findings: BatchImportFindingsRequestFindingList;
- }
- export type BatchImportFindingsRequestFindingList = AwsSecurityFinding[];
- export interface BatchImportFindingsResponse {
- /**
- * The number of findings that failed to import.
- */
- FailedCount: Integer;
- /**
- * The number of findings that were successfully imported.
- */
- SuccessCount: Integer;
- /**
- * The list of findings that failed to import.
- */
- FailedFindings?: ImportFindingsErrorList;
- }
- export interface BatchUpdateAutomationRulesRequest {
- /**
- * An array of ARNs for the rules that are to be updated. Optionally, you can also include RuleStatus and RuleOrder.
- */
- UpdateAutomationRulesRequestItems: UpdateAutomationRulesRequestItemsList;
- }
- export interface BatchUpdateAutomationRulesResponse {
- /**
- * A list of properly processed rule ARNs.
- */
- ProcessedAutomationRules?: AutomationRulesArnsList;
- /**
- * A list of objects containing RuleArn, ErrorCode, and ErrorMessage. This parameter tells you which automation rules the request didn't update and why.
- */
- UnprocessedAutomationRules?: UnprocessedAutomationRulesList;
- }
- export interface BatchUpdateFindingsRequest {
- /**
- * The list of findings to update. BatchUpdateFindings can be used to update up to 100 findings at a time. For each finding, the list provides the finding identifier and the ARN of the finding provider.
- */
- FindingIdentifiers: AwsSecurityFindingIdentifierList;
- Note?: NoteUpdate;
- /**
- * Used to update the finding severity.
- */
- Severity?: SeverityUpdate;
- /**
- * Indicates the veracity of a finding. The available values for VerificationState are as follows. UNKNOWN – The default disposition of a security finding TRUE_POSITIVE – The security finding is confirmed FALSE_POSITIVE – The security finding was determined to be a false alarm BENIGN_POSITIVE – A special case of TRUE_POSITIVE where the finding doesn't pose any threat, is expected, or both
- */
- VerificationState?: VerificationState;
- /**
- * The updated value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- */
- Confidence?: RatioScale;
- /**
- * The updated value for the level of importance assigned to the resources associated with the findings. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- */
- Criticality?: RatioScale;
- /**
- * One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are as follows. Software and Configuration Checks TTPs Effects Unusual Behaviors Sensitive Data Identifications
- */
- Types?: TypeList;
- /**
- * A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
- */
- UserDefinedFields?: FieldMap;
- /**
- * Used to update the workflow status of a finding. The workflow status indicates the progress of the investigation into the finding.
- */
- Workflow?: WorkflowUpdate;
- /**
- * A list of findings that are related to the updated findings.
- */
- RelatedFindings?: RelatedFindingList;
- }
- export interface BatchUpdateFindingsResponse {
- /**
- * The list of findings that were updated successfully.
- */
- ProcessedFindings: AwsSecurityFindingIdentifierList;
- /**
- * The list of findings that were not updated.
- */
- UnprocessedFindings: BatchUpdateFindingsUnprocessedFindingsList;
- }
- export interface BatchUpdateFindingsUnprocessedFinding {
- /**
- * The identifier of the finding that was not updated.
- */
- FindingIdentifier: AwsSecurityFindingIdentifier;
- /**
- * The code associated with the error. Possible values are: ConcurrentUpdateError - Another request attempted to update the finding while this request was being processed. This error may also occur if you call BatchUpdateFindings and BatchImportFindings at the same time. DuplicatedFindingIdentifier - The request included two or more findings with the same FindingIdentifier. FindingNotFound - The FindingIdentifier included in the request did not match an existing finding. FindingSizeExceeded - The finding size was greater than the permissible value of 240 KB. InternalFailure - An internal service failure occurred when updating the finding. InvalidInput - The finding update contained an invalid value that did not satisfy the Amazon Web Services Security Finding Format syntax.
- */
- ErrorCode: NonEmptyString;
- /**
- * The message associated with the error. Possible values are: Concurrent finding updates detected Finding Identifier is duplicated Finding Not Found Finding size exceeded 240 KB Internal service failure Invalid Input
- */
- ErrorMessage: NonEmptyString;
- }
- export type BatchUpdateFindingsUnprocessedFindingsList = BatchUpdateFindingsUnprocessedFinding[];
- export interface BatchUpdateStandardsControlAssociationsRequest {
- /**
- * Updates the enablement status of a security control in a specified standard.
- */
- StandardsControlAssociationUpdates: StandardsControlAssociationUpdates;
- }
- export interface BatchUpdateStandardsControlAssociationsResponse {
- /**
- * A security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) whose enablement status in a specified standard couldn't be updated.
- */
- UnprocessedAssociationUpdates?: UnprocessedStandardsControlAssociationUpdates;
- }
- export type Boolean = boolean;
- export interface BooleanConfigurationOptions {
- /**
- * The Security Hub default value for a boolean parameter.
- */
- DefaultValue?: Boolean;
- }
- export interface BooleanFilter {
- /**
- * The value of the boolean.
- */
- Value?: Boolean;
- }
- export type BooleanFilterList = BooleanFilter[];
- export type CategoryList = NonEmptyString[];
- export interface Cell {
- /**
- * The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.
- */
- Column?: Long;
- /**
- * The row number of the row that contains the data.
- */
- Row?: Long;
- /**
- * The name of the column that contains the data.
- */
- ColumnName?: NonEmptyString;
- /**
- * For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.
- */
- CellReference?: NonEmptyString;
- }
- export type Cells = Cell[];
- export interface CidrBlockAssociation {
- /**
- * The association ID for the IPv4 CIDR block.
- */
- AssociationId?: NonEmptyString;
- /**
- * The IPv4 CIDR block.
- */
- CidrBlock?: NonEmptyString;
- /**
- * Information about the state of the IPv4 CIDR block.
- */
- CidrBlockState?: NonEmptyString;
- }
- export type CidrBlockAssociationList = CidrBlockAssociation[];
- export interface City {
- /**
- * The name of the city.
- */
- CityName?: NonEmptyString;
- }
- export interface ClassificationResult {
- /**
- * The type of content that the finding applies to.
- */
- MimeType?: NonEmptyString;
- /**
- * The total size in bytes of the affected data.
- */
- SizeClassified?: Long;
- /**
- * Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.
- */
- AdditionalOccurrences?: Boolean;
- /**
- * The current status of the sensitive data detection.
- */
- Status?: ClassificationStatus;
- /**
- * Provides details about sensitive data that was identified based on built-in configuration.
- */
- SensitiveData?: SensitiveDataResultList;
- /**
- * Provides details about sensitive data that was identified based on customer-defined configuration.
- */
- CustomDataIdentifiers?: CustomDataIdentifiersResult;
- }
- export interface ClassificationStatus {
- /**
- * The code that represents the status of the sensitive data detection.
- */
- Code?: NonEmptyString;
- /**
- * A longer description of the current status of the sensitive data detection.
- */
- Reason?: NonEmptyString;
- }
- export interface CloudWatchLogsLogGroupArnConfigDetails {
- /**
- * The ARN of the CloudWatch Logs log group that Route 53 is publishing logs to.
- */
- CloudWatchLogsLogGroupArn?: NonEmptyString;
- /**
- * The ID of the hosted zone that CloudWatch Logs is logging queries for.
- */
- HostedZoneId?: NonEmptyString;
- /**
- * The ID for a DNS query logging configuration.
- */
- Id?: NonEmptyString;
- }
- export interface CodeVulnerabilitiesFilePath {
- /**
- * The line number of the last line of code in which the vulnerability is located.
- */
- EndLine?: Integer;
- /**
- * The name of the file in which the code vulnerability is located.
- */
- FileName?: NonEmptyString;
- /**
- * The file path to the code in which the vulnerability is located.
- */
- FilePath?: NonEmptyString;
- /**
- * The line number of the first line of code in which the vulnerability is located.
- */
- StartLine?: Integer;
- }
- export interface Compliance {
- /**
- * The result of a standards check. The valid values for Status are as follows. PASSED - Standards check passed for all evaluated resources. WARNING - Some information is missing or this check is not supported for your configuration. FAILED - Standards check failed for at least one evaluated resource. NOT_AVAILABLE - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was NOT_APPLICABLE. If the Config evaluation result was NOT_APPLICABLE, then after 3 days, Security Hub automatically archives the finding.
- */
- Status?: ComplianceStatus;
- /**
- * For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.
- */
- RelatedRequirements?: RelatedRequirementsList;
- /**
- * For findings generated from controls, a list of reasons behind the value of Status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.
- */
- StatusReasons?: StatusReasonsList;
- /**
- * The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5.
- */
- SecurityControlId?: NonEmptyString;
- /**
- * The enabled security standards in which a security control is currently enabled.
- */
- AssociatedStandards?: AssociatedStandardsList;
- /**
- * An object that includes security control parameter names and values.
- */
- SecurityControlParameters?: SecurityControlParametersList;
- }
- export type ComplianceStatus = "PASSED"|"WARNING"|"FAILED"|"NOT_AVAILABLE"|string;
- export interface ConfigurationOptions {
- /**
- * The options for customizing a security control parameter that is an integer.
- */
- Integer?: IntegerConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a list of integers.
- */
- IntegerList?: IntegerListConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a double.
- */
- Double?: DoubleConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a string data type.
- */
- String?: StringConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a list of strings.
- */
- StringList?: StringListConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a boolean. For a boolean parameter, the options are true and false.
- */
- Boolean?: BooleanConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is an enum.
- */
- Enum?: EnumConfigurationOptions;
- /**
- * The options for customizing a security control parameter that is a list of enums.
- */
- EnumList?: EnumListConfigurationOptions;
- }
- export interface ConfigurationPolicyAssociation {
- /**
- * The target account, organizational unit, or the root.
- */
- Target?: Target;
- }
- export type ConfigurationPolicyAssociationList = ConfigurationPolicyAssociationSummary[];
- export type ConfigurationPolicyAssociationStatus = "PENDING"|"SUCCESS"|"FAILED"|string;
- export interface ConfigurationPolicyAssociationSummary {
- /**
- * The universally unique identifier (UUID) of the configuration policy.
- */
- ConfigurationPolicyId?: NonEmptyString;
- /**
- * The identifier of the target account, organizational unit, or the root.
- */
- TargetId?: NonEmptyString;
- /**
- * Specifies whether the target is an Amazon Web Services account, organizational unit, or the root.
- */
- TargetType?: TargetType;
- /**
- * Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.
- */
- AssociationType?: AssociationType;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The current status of the association between the specified target and the configuration.
- */
- AssociationStatus?: ConfigurationPolicyAssociationStatus;
- /**
- * The explanation for a FAILED value for AssociationStatus.
- */
- AssociationStatusMessage?: NonEmptyString;
- }
- export type ConfigurationPolicyAssociationSummaryList = ConfigurationPolicyAssociationSummary[];
- export type ConfigurationPolicyAssociationsList = ConfigurationPolicyAssociation[];
- export interface ConfigurationPolicySummary {
- /**
- * The Amazon Resource Name (ARN) of the configuration policy.
- */
- Arn?: NonEmptyString;
- /**
- * The universally unique identifier (UUID) of the configuration policy.
- */
- Id?: NonEmptyString;
- /**
- * The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, /.
- */
- Name?: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * Indicates whether the service that the configuration policy applies to is enabled in the policy.
- */
- ServiceEnabled?: Boolean;
- }
- export type ConfigurationPolicySummaryList = ConfigurationPolicySummary[];
- export interface ContainerDetails {
- /**
- * The runtime of the container.
- */
- ContainerRuntime?: NonEmptyString;
- /**
- * The name of the container related to a finding.
- */
- Name?: NonEmptyString;
- /**
- * The identifier of the container image related to a finding.
- */
- ImageId?: NonEmptyString;
- /**
- * The name of the container image related to a finding.
- */
- ImageName?: NonEmptyString;
- /**
- * Indicates when the container started. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LaunchedAt?: NonEmptyString;
- /**
- * Provides information about the mounting of a volume in a container.
- */
- VolumeMounts?: VolumeMountList;
- /**
- * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
- */
- Privileged?: Boolean;
- }
- export type ControlFindingGenerator = "STANDARD_CONTROL"|"SECURITY_CONTROL"|string;
- export type ControlStatus = "ENABLED"|"DISABLED"|string;
- export interface Country {
- /**
- * The 2-letter ISO 3166 country code for the country.
- */
- CountryCode?: NonEmptyString;
- /**
- * The name of the country.
- */
- CountryName?: NonEmptyString;
- }
- export interface CreateActionTargetRequest {
- /**
- * The name of the custom action target. Can contain up to 20 characters.
- */
- Name: NonEmptyString;
- /**
- * The description for the custom action target.
- */
- Description: NonEmptyString;
- /**
- * The ID for the custom action target. Can contain up to 20 alphanumeric characters.
- */
- Id: NonEmptyString;
- }
- export interface CreateActionTargetResponse {
- /**
- * The Amazon Resource Name (ARN) for the custom action target.
- */
- ActionTargetArn: NonEmptyString;
- }
- export interface CreateAutomationRuleRequest {
- /**
- * User-defined tags associated with an automation rule.
- */
- Tags?: TagMap;
- /**
- * Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
- */
- RuleStatus?: RuleStatus;
- /**
- * An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
- */
- RuleOrder: RuleOrderValue;
- /**
- * The name of the rule.
- */
- RuleName: NonEmptyString;
- /**
- * A description of the rule.
- */
- Description: NonEmptyString;
- /**
- * Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
- */
- IsTerminal?: Boolean;
- /**
- * A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
- */
- Criteria: AutomationRulesFindingFilters;
- /**
- * One or more actions to update finding fields if a finding matches the conditions specified in Criteria.
- */
- Actions: ActionList;
- }
- export interface CreateAutomationRuleResponse {
- /**
- * The Amazon Resource Name (ARN) of the automation rule that you created.
- */
- RuleArn?: NonEmptyString;
- }
- export interface CreateConfigurationPolicyRequest {
- /**
- * The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, /.
- */
- Name: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).
- */
- ConfigurationPolicy: Policy;
- /**
- * User-defined tags associated with a configuration policy. For more information, see Tagging Security Hub resources in the Security Hub user guide.
- */
- Tags?: TagMap;
- }
- export interface CreateConfigurationPolicyResponse {
- /**
- * The Amazon Resource Name (ARN) of the configuration policy.
- */
- Arn?: NonEmptyString;
- /**
- * The universally unique identifier (UUID) of the configuration policy.
- */
- Id?: NonEmptyString;
- /**
- * The name of the configuration policy.
- */
- Name?: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
- */
- CreatedAt?: Timestamp;
- /**
- * An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).
- */
- ConfigurationPolicy?: Policy;
- }
- export interface CreateFindingAggregatorRequest {
- /**
- * Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. The selected option also determines how to use the Regions provided in the Regions list. The options are as follows: ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
- */
- RegionLinkingMode: NonEmptyString;
- /**
- * If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
- */
- Regions?: StringList;
- }
- export interface CreateFindingAggregatorResponse {
- /**
- * The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and stop finding aggregation.
- */
- FindingAggregatorArn?: NonEmptyString;
- /**
- * The aggregation Region.
- */
- FindingAggregationRegion?: NonEmptyString;
- /**
- * Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- */
- RegionLinkingMode?: NonEmptyString;
- /**
- * The list of excluded Regions or included Regions.
- */
- Regions?: StringList;
- }
- export interface CreateInsightRequest {
- /**
- * The name of the custom insight to create.
- */
- Name: NonEmptyString;
- /**
- * One or more attributes used to filter the findings included in the insight. The insight only includes findings that match the criteria defined in the filters.
- */
- Filters: AwsSecurityFindingFilters;
- /**
- * The attribute used to group the findings for the insight. The grouping attribute identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
- */
- GroupByAttribute: NonEmptyString;
- }
- export interface CreateInsightResponse {
- /**
- * The ARN of the insight created.
- */
- InsightArn: NonEmptyString;
- }
- export interface CreateMembersRequest {
- /**
- * The list of accounts to associate with the Security Hub administrator account. For each account, the list includes the account ID and optionally the email address.
- */
- AccountDetails: AccountDetailsList;
- }
- export interface CreateMembersResponse {
- /**
- * The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export type CrossAccountMaxResults = number;
- export interface CustomDataIdentifiersDetections {
- /**
- * The total number of occurrences of sensitive data that were detected.
- */
- Count?: Long;
- /**
- * The ARN of the custom identifier that was used to detect the sensitive data.
- */
- Arn?: NonEmptyString;
- /**
- * he name of the custom identifier that detected the sensitive data.
- */
- Name?: NonEmptyString;
- /**
- * Details about the sensitive data that was detected.
- */
- Occurrences?: Occurrences;
- }
- export type CustomDataIdentifiersDetectionsList = CustomDataIdentifiersDetections[];
- export interface CustomDataIdentifiersResult {
- /**
- * The list of detected instances of sensitive data.
- */
- Detections?: CustomDataIdentifiersDetectionsList;
- /**
- * The total number of occurrences of sensitive data.
- */
- TotalCount?: Long;
- }
- export type CustomizableProperties = SecurityControlProperty[];
- export interface Cvss {
- /**
- * The version of CVSS for the CVSS score.
- */
- Version?: NonEmptyString;
- /**
- * The base CVSS score.
- */
- BaseScore?: Double;
- /**
- * The base scoring vector for the CVSS score.
- */
- BaseVector?: NonEmptyString;
- /**
- * The origin of the original CVSS score and vector.
- */
- Source?: NonEmptyString;
- /**
- * Adjustments to the CVSS metrics.
- */
- Adjustments?: AdjustmentList;
- }
- export type CvssList = Cvss[];
- export interface DataClassificationDetails {
- /**
- * The path to the folder or file that contains the sensitive data.
- */
- DetailedResultsLocation?: NonEmptyString;
- /**
- * The details about the sensitive data that was detected on the resource.
- */
- Result?: ClassificationResult;
- }
- export interface DateFilter {
- /**
- * A timestamp that provides the start date for the date filter. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- Start?: NonEmptyString;
- /**
- * A timestamp that provides the end date for the date filter. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- End?: NonEmptyString;
- /**
- * A date range for the date filter.
- */
- DateRange?: DateRange;
- }
- export type DateFilterList = DateFilter[];
- export interface DateRange {
- /**
- * A date range value for the date filter.
- */
- Value?: Integer;
- /**
- * A date range unit for the date filter.
- */
- Unit?: DateRangeUnit;
- }
- export type DateRangeUnit = "DAYS"|string;
- export interface DeclineInvitationsRequest {
- /**
- * The list of prospective member account IDs for which to decline an invitation.
- */
- AccountIds: AccountIdList;
- }
- export interface DeclineInvitationsResponse {
- /**
- * The list of Amazon Web Services accounts that were not processed. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export interface DeleteActionTargetRequest {
- /**
- * The Amazon Resource Name (ARN) of the custom action target to delete.
- */
- ActionTargetArn: NonEmptyString;
- }
- export interface DeleteActionTargetResponse {
- /**
- * The ARN of the custom action target that was deleted.
- */
- ActionTargetArn: NonEmptyString;
- }
- export interface DeleteConfigurationPolicyRequest {
- /**
- * The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
- */
- Identifier: NonEmptyString;
- }
- export interface DeleteConfigurationPolicyResponse {
- }
- export interface DeleteFindingAggregatorRequest {
- /**
- * The ARN of the finding aggregator to delete. To obtain the ARN, use ListFindingAggregators.
- */
- FindingAggregatorArn: NonEmptyString;
- }
- export interface DeleteFindingAggregatorResponse {
- }
- export interface DeleteInsightRequest {
- /**
- * The ARN of the insight to delete.
- */
- InsightArn: NonEmptyString;
- }
- export interface DeleteInsightResponse {
- /**
- * The ARN of the insight that was deleted.
- */
- InsightArn: NonEmptyString;
- }
- export interface DeleteInvitationsRequest {
- /**
- * The list of member account IDs that received the invitations you want to delete.
- */
- AccountIds: AccountIdList;
- }
- export interface DeleteInvitationsResponse {
- /**
- * The list of Amazon Web Services accounts for which the invitations were not deleted. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export interface DeleteMembersRequest {
- /**
- * The list of account IDs for the member accounts to delete.
- */
- AccountIds: AccountIdList;
- }
- export interface DeleteMembersResponse {
- /**
- * The list of Amazon Web Services accounts that were not deleted. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export interface DescribeActionTargetsRequest {
- /**
- * A list of custom action target ARNs for the custom action targets to retrieve.
- */
- ActionTargetArns?: ArnList;
- /**
- * The token that is required for pagination. On your first call to the DescribeActionTargets operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeActionTargetsResponse {
- /**
- * A list of ActionTarget objects. Each object includes the ActionTargetArn, Description, and Name of a custom action target available in Security Hub.
- */
- ActionTargets: ActionTargetList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeHubRequest {
- /**
- * The ARN of the Hub resource to retrieve.
- */
- HubArn?: NonEmptyString;
- }
- export interface DescribeHubResponse {
- /**
- * The ARN of the Hub resource that was retrieved.
- */
- HubArn?: NonEmptyString;
- /**
- * The date and time when Security Hub was enabled in the account.
- */
- SubscribedAt?: NonEmptyString;
- /**
- * Whether to automatically enable new controls when they are added to standards that are enabled. If set to true, then new controls for enabled standards are enabled automatically. If set to false, then new controls are not enabled.
- */
- AutoEnableControls?: Boolean;
- /**
- * Specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 23, 2023.
- */
- ControlFindingGenerator?: ControlFindingGenerator;
- }
- export interface DescribeOrganizationConfigurationRequest {
- }
- export interface DescribeOrganizationConfigurationResponse {
- /**
- * Whether to automatically enable Security Hub in new member accounts when they join the organization. If set to true, then Security Hub is automatically enabled in new accounts. If set to false, then Security Hub isn't enabled in new accounts automatically. The default value is false. If the ConfigurationType of your organization is set to CENTRAL, then this field is set to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub is enabled and associate the policy with new organization accounts.
- */
- AutoEnable?: Boolean;
- /**
- * Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
- */
- MemberAccountLimitReached?: Boolean;
- /**
- * Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts. The default value of this parameter is equal to DEFAULT. If the ConfigurationType of your organization is set to CENTRAL, then this field is set to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.
- */
- AutoEnableStandards?: AutoEnableStandards;
- OrganizationConfiguration?: OrganizationConfiguration;
- }
- export interface DescribeProductsRequest {
- /**
- * The token that is required for pagination. On your first call to the DescribeProducts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return.
- */
- MaxResults?: MaxResults;
- /**
- * The ARN of the integration to return.
- */
- ProductArn?: NonEmptyString;
- }
- export interface DescribeProductsResponse {
- /**
- * A list of products, including details for each product.
- */
- Products: ProductsList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeStandardsControlsRequest {
- /**
- * The ARN of a resource that represents your subscription to a supported standard. To get the subscription ARNs of the standards you have enabled, use the GetEnabledStandards operation.
- */
- StandardsSubscriptionArn: NonEmptyString;
- /**
- * The token that is required for pagination. On your first call to the DescribeStandardsControls operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of security standard controls to return.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeStandardsControlsResponse {
- /**
- * A list of security standards controls.
- */
- Controls?: StandardsControls;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface DescribeStandardsRequest {
- /**
- * The token that is required for pagination. On your first call to the DescribeStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of standards to return.
- */
- MaxResults?: MaxResults;
- }
- export interface DescribeStandardsResponse {
- /**
- * A list of available standards.
- */
- Standards?: Standards;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface DisableImportFindingsForProductRequest {
- /**
- * The ARN of the integrated product to disable the integration for.
- */
- ProductSubscriptionArn: NonEmptyString;
- }
- export interface DisableImportFindingsForProductResponse {
- }
- export interface DisableOrganizationAdminAccountRequest {
- /**
- * The Amazon Web Services account identifier of the Security Hub administrator account.
- */
- AdminAccountId: NonEmptyString;
- }
- export interface DisableOrganizationAdminAccountResponse {
- }
- export interface DisableSecurityHubRequest {
- }
- export interface DisableSecurityHubResponse {
- }
- export type DisabledSecurityControlIdentifierList = NonEmptyString[];
- export interface DisassociateFromAdministratorAccountRequest {
- }
- export interface DisassociateFromAdministratorAccountResponse {
- }
- export interface DisassociateFromMasterAccountRequest {
- }
- export interface DisassociateFromMasterAccountResponse {
- }
- export interface DisassociateMembersRequest {
- /**
- * The account IDs of the member accounts to disassociate from the administrator account.
- */
- AccountIds: AccountIdList;
- }
- export interface DisassociateMembersResponse {
- }
- export interface DnsRequestAction {
- /**
- * The DNS domain that is associated with the DNS request.
- */
- Domain?: NonEmptyString;
- /**
- * The protocol that was used for the DNS request.
- */
- Protocol?: NonEmptyString;
- /**
- * Indicates whether the DNS request was blocked.
- */
- Blocked?: Boolean;
- }
- export type Double = number;
- export interface DoubleConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is a double.
- */
- DefaultValue?: Double;
- /**
- * The minimum valid value for a control parameter that is a double.
- */
- Min?: Double;
- /**
- * The maximum valid value for a control parameter that is a double.
- */
- Max?: Double;
- }
- export interface EnableImportFindingsForProductRequest {
- /**
- * The ARN of the product to enable the integration for.
- */
- ProductArn: NonEmptyString;
- }
- export interface EnableImportFindingsForProductResponse {
- /**
- * The ARN of your subscription to the product to enable integrations for.
- */
- ProductSubscriptionArn?: NonEmptyString;
- }
- export interface EnableOrganizationAdminAccountRequest {
- /**
- * The Amazon Web Services account identifier of the account to designate as the Security Hub administrator account.
- */
- AdminAccountId: NonEmptyString;
- }
- export interface EnableOrganizationAdminAccountResponse {
- }
- export interface EnableSecurityHubRequest {
- /**
- * The tags to add to the hub resource when you enable Security Hub.
- */
- Tags?: TagMap;
- /**
- * Whether to enable the security standards that Security Hub has designated as automatically enabled. If you do not provide a value for EnableDefaultStandards, it is set to true. To not enable the automatically enabled standards, set EnableDefaultStandards to false.
- */
- EnableDefaultStandards?: Boolean;
- /**
- * This field, used when enabling Security Hub, specifies whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. The value for this field in a member account matches the value in the administrator account. For accounts that aren't part of an organization, the default value of this field is SECURITY_CONTROL if you enabled Security Hub on or after February 23, 2023.
- */
- ControlFindingGenerator?: ControlFindingGenerator;
- }
- export interface EnableSecurityHubResponse {
- }
- export type EnabledSecurityControlIdentifierList = NonEmptyString[];
- export type EnabledStandardIdentifierList = NonEmptyString[];
- export interface EnumConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is an enum.
- */
- DefaultValue?: NonEmptyString;
- /**
- * The valid values for a control parameter that is an enum.
- */
- AllowedValues?: StringList;
- }
- export interface EnumListConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is a list of enums.
- */
- DefaultValue?: StringList;
- /**
- * The maximum number of list items that an enum list control parameter can accept.
- */
- MaxItems?: Integer;
- /**
- * The valid values for a control parameter that is a list of enums.
- */
- AllowedValues?: StringList;
- }
- export type FieldMap = {[key: string]: NonEmptyString};
- export type FilePathList = FilePaths[];
- export interface FilePaths {
- /**
- * Path to the infected or suspicious file on the resource it was detected on.
- */
- FilePath?: NonEmptyString;
- /**
- * The name of the infected or suspicious file corresponding to the hash.
- */
- FileName?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the resource on which the threat was detected.
- */
- ResourceId?: NonEmptyString;
- /**
- * The hash value for the infected or suspicious file.
- */
- Hash?: NonEmptyString;
- }
- export interface FindingAggregator {
- /**
- * The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.
- */
- FindingAggregatorArn?: NonEmptyString;
- }
- export type FindingAggregatorList = FindingAggregator[];
- export interface FindingHistoryRecord {
- FindingIdentifier?: AwsSecurityFindingIdentifier;
- /**
- * A timestamp that indicates when Security Hub processed the updated finding record. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdateTime?: Timestamp;
- /**
- * Identifies whether the event marks the creation of a new finding. A value of True means that the finding is newly created. A value of False means that the finding isn’t newly created.
- */
- FindingCreated?: Boolean;
- /**
- * Identifies the source of the event that changed the finding. For example, an integrated Amazon Web Service or third-party partner integration may call BatchImportFindings , or an Security Hub customer may call BatchUpdateFindings .
- */
- UpdateSource?: FindingHistoryUpdateSource;
- /**
- * An array of objects that provides details about the finding change event, including the Amazon Web Services Security Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after the change.
- */
- Updates?: FindingHistoryUpdatesList;
- /**
- * A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory to get up to an additional 100 results of history for the same finding that you specified in your initial request.
- */
- NextToken?: NextToken;
- }
- export type FindingHistoryRecordList = FindingHistoryRecord[];
- export interface FindingHistoryUpdate {
- /**
- * The ASFF field that changed during the finding change event.
- */
- UpdatedField?: NonEmptyString;
- /**
- * The value of the ASFF field before the finding change event.
- */
- OldValue?: NonEmptyString;
- /**
- * The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value if FindingHistoryRecord exceeds database limits.
- */
- NewValue?: NonEmptyString;
- }
- export interface FindingHistoryUpdateSource {
- /**
- * Describes the type of finding change event, such as a call to BatchImportFindings (by an integrated Amazon Web Service or third party partner integration) or BatchUpdateFindings (by a Security Hub customer).
- */
- Type?: FindingHistoryUpdateSourceType;
- /**
- * The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.
- */
- Identity?: NonEmptyString;
- }
- export type FindingHistoryUpdateSourceType = "BATCH_UPDATE_FINDINGS"|"BATCH_IMPORT_FINDINGS"|string;
- export type FindingHistoryUpdatesList = FindingHistoryUpdate[];
- export interface FindingProviderFields {
- /**
- * A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify. Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.
- */
- Confidence?: RatioScale;
- /**
- * The level of importance assigned to the resources associated with the finding. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.
- */
- Criticality?: RatioScale;
- /**
- * A list of findings that are related to the current finding.
- */
- RelatedFindings?: RelatedFindingList;
- /**
- * The severity of a finding.
- */
- Severity?: FindingProviderSeverity;
- /**
- * One or more finding types in the format of namespace/category/classifier that classify a finding. Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications
- */
- Types?: TypeList;
- }
- export interface FindingProviderSeverity {
- /**
- * The severity label assigned to the finding by the finding provider.
- */
- Label?: SeverityLabel;
- /**
- * The finding provider's original value for the severity.
- */
- Original?: NonEmptyString;
- }
- export interface FirewallPolicyDetails {
- /**
- * The stateful rule groups that are used in the firewall policy.
- */
- StatefulRuleGroupReferences?: FirewallPolicyStatefulRuleGroupReferencesList;
- /**
- * The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.
- */
- StatelessCustomActions?: FirewallPolicyStatelessCustomActionsList;
- /**
- * The actions to take on a packet if it doesn't match any of the stateless rules in the policy. You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.
- */
- StatelessDefaultActions?: NonEmptyStringList;
- /**
- * The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. You must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.
- */
- StatelessFragmentDefaultActions?: NonEmptyStringList;
- /**
- * The stateless rule groups that are used in the firewall policy.
- */
- StatelessRuleGroupReferences?: FirewallPolicyStatelessRuleGroupReferencesList;
- }
- export interface FirewallPolicyStatefulRuleGroupReferencesDetails {
- /**
- * The ARN of the stateful rule group.
- */
- ResourceArn?: NonEmptyString;
- }
- export type FirewallPolicyStatefulRuleGroupReferencesList = FirewallPolicyStatefulRuleGroupReferencesDetails[];
- export interface FirewallPolicyStatelessCustomActionsDetails {
- /**
- * The definition of the custom action.
- */
- ActionDefinition?: StatelessCustomActionDefinition;
- /**
- * The name of the custom action.
- */
- ActionName?: NonEmptyString;
- }
- export type FirewallPolicyStatelessCustomActionsList = FirewallPolicyStatelessCustomActionsDetails[];
- export interface FirewallPolicyStatelessRuleGroupReferencesDetails {
- /**
- * The order in which to run the stateless rule group.
- */
- Priority?: Integer;
- /**
- * The ARN of the stateless rule group.
- */
- ResourceArn?: NonEmptyString;
- }
- export type FirewallPolicyStatelessRuleGroupReferencesList = FirewallPolicyStatelessRuleGroupReferencesDetails[];
- export interface GeneratorDetails {
- /**
- * The name of the detector used to identify the code vulnerability.
- */
- Name?: NonEmptyString;
- /**
- * The description of the detector used to identify the code vulnerability.
- */
- Description?: NonEmptyString;
- /**
- * An array of tags used to identify the detector associated with the finding.
- */
- Labels?: TypeList;
- }
- export interface GeoLocation {
- /**
- * The longitude of the location.
- */
- Lon?: Double;
- /**
- * The latitude of the location.
- */
- Lat?: Double;
- }
- export interface GetAdministratorAccountRequest {
- }
- export interface GetAdministratorAccountResponse {
- Administrator?: Invitation;
- }
- export interface GetConfigurationPolicyAssociationRequest {
- /**
- * The target account ID, organizational unit ID, or the root ID to retrieve the association for.
- */
- Target: Target;
- }
- export interface GetConfigurationPolicyAssociationResponse {
- /**
- * The universally unique identifier (UUID) of a configuration policy. For self-managed behavior, the value is SELF_MANAGED_SECURITY_HUB.
- */
- ConfigurationPolicyId?: NonEmptyString;
- /**
- * The target account ID, organizational unit ID, or the root ID for which the association is retrieved.
- */
- TargetId?: NonEmptyString;
- /**
- * Specifies whether the target is an Amazon Web Services account, organizational unit, or the organization root.
- */
- TargetType?: TargetType;
- /**
- * Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.
- */
- AssociationType?: AssociationType;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The current status of the association between the specified target and the configuration.
- */
- AssociationStatus?: ConfigurationPolicyAssociationStatus;
- /**
- * The explanation for a FAILED value for AssociationStatus.
- */
- AssociationStatusMessage?: NonEmptyString;
- }
- export interface GetConfigurationPolicyRequest {
- /**
- * The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
- */
- Identifier: NonEmptyString;
- }
- export interface GetConfigurationPolicyResponse {
- /**
- * The ARN of the configuration policy.
- */
- Arn?: NonEmptyString;
- /**
- * The UUID of the configuration policy.
- */
- Id?: NonEmptyString;
- /**
- * The name of the configuration policy.
- */
- Name?: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
- */
- CreatedAt?: Timestamp;
- /**
- * An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the policy includes a list of security controls that are enabled, Security Hub disables all other controls (including newly released controls). If the policy includes a list of security controls that are disabled, Security Hub enables all other controls (including newly released controls).
- */
- ConfigurationPolicy?: Policy;
- }
- export interface GetEnabledStandardsRequest {
- /**
- * The list of the standards subscription ARNs for the standards to retrieve.
- */
- StandardsSubscriptionArns?: StandardsSubscriptionArns;
- /**
- * The token that is required for pagination. On your first call to the GetEnabledStandards operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return in the response.
- */
- MaxResults?: MaxResults;
- }
- export interface GetEnabledStandardsResponse {
- /**
- * The list of StandardsSubscriptions objects that include information about the enabled standards.
- */
- StandardsSubscriptions?: StandardsSubscriptions;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface GetFindingAggregatorRequest {
- /**
- * The ARN of the finding aggregator to return details for. To obtain the ARN, use ListFindingAggregators.
- */
- FindingAggregatorArn: NonEmptyString;
- }
- export interface GetFindingAggregatorResponse {
- /**
- * The ARN of the finding aggregator.
- */
- FindingAggregatorArn?: NonEmptyString;
- /**
- * The aggregation Region.
- */
- FindingAggregationRegion?: NonEmptyString;
- /**
- * Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- */
- RegionLinkingMode?: NonEmptyString;
- /**
- * The list of excluded Regions or included Regions.
- */
- Regions?: StringList;
- }
- export interface GetFindingHistoryRequest {
- FindingIdentifier: AwsSecurityFindingIdentifier;
- /**
- * A timestamp that indicates the start time of the requested finding history. If you provide values for both StartTime and EndTime, Security Hub returns finding history for the specified time period. If you provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at which the API is called. If you provide a value for EndTime but not for StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither StartTime nor EndTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- StartTime?: Timestamp;
- /**
- * An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. If you provide values for both StartTime and EndTime, Security Hub returns finding history for the specified time period. If you provide a value for StartTime but not for EndTime, Security Hub returns finding history from the StartTime to the time at which the API is called. If you provide a value for EndTime but not for StartTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the EndTime. If you provide neither StartTime nor EndTime, Security Hub returns finding history from the CreatedAt timestamp of the finding to the time at which the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is limited to 90 days. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- EndTime?: Timestamp;
- /**
- * A token for pagination purposes. Provide NULL as the initial value. In subsequent requests, provide the token included in the response to get up to an additional 100 results of finding history. If you don’t provide NextToken, Security Hub returns up to 100 results of finding history for each request.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.
- */
- MaxResults?: MaxResults;
- }
- export interface GetFindingHistoryResponse {
- /**
- * A list of events that altered the specified finding during the specified time period.
- */
- Records?: FindingHistoryRecordList;
- /**
- * A token for pagination purposes. Provide this token in the subsequent request to GetFindingsHistory to get up to an additional 100 results of history for the same finding that you specified in your initial request.
- */
- NextToken?: NextToken;
- }
- export interface GetFindingsRequest {
- /**
- * The finding attributes used to define a condition to filter the returned findings. You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values. Note that in the available filter fields, WorkflowState is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.
- */
- Filters?: AwsSecurityFindingFilters;
- /**
- * The finding attributes used to sort the list of returned findings.
- */
- SortCriteria?: SortCriteria;
- /**
- * The token that is required for pagination. On your first call to the GetFindings operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of findings to return.
- */
- MaxResults?: MaxResults;
- }
- export interface GetFindingsResponse {
- /**
- * The findings that matched the filters specified in the request.
- */
- Findings: AwsSecurityFindingList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface GetInsightResultsRequest {
- /**
- * The ARN of the insight for which to return results.
- */
- InsightArn: NonEmptyString;
- }
- export interface GetInsightResultsResponse {
- /**
- * The insight results returned by the operation.
- */
- InsightResults: InsightResults;
- }
- export interface GetInsightsRequest {
- /**
- * The ARNs of the insights to describe. If you do not provide any insight ARNs, then GetInsights returns all of your custom insights. It does not return any managed insights.
- */
- InsightArns?: ArnList;
- /**
- * The token that is required for pagination. On your first call to the GetInsights operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of items to return in the response.
- */
- MaxResults?: MaxResults;
- }
- export interface GetInsightsResponse {
- /**
- * The insights returned by the operation.
- */
- Insights: InsightList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface GetInvitationsCountRequest {
- }
- export interface GetInvitationsCountResponse {
- /**
- * The number of all membership invitations sent to this Security Hub member account, not including the currently accepted invitation.
- */
- InvitationsCount?: Integer;
- }
- export interface GetMasterAccountRequest {
- }
- export interface GetMasterAccountResponse {
- /**
- * A list of details about the Security Hub administrator account for the current member account.
- */
- Master?: Invitation;
- }
- export interface GetMembersRequest {
- /**
- * The list of account IDs for the Security Hub member accounts to return the details for.
- */
- AccountIds: AccountIdList;
- }
- export interface GetMembersResponse {
- /**
- * The list of details about the Security Hub member accounts.
- */
- Members?: MemberList;
- /**
- * The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export interface GetSecurityControlDefinitionRequest {
- /**
- * The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).
- */
- SecurityControlId: NonEmptyString;
- }
- export interface GetSecurityControlDefinitionResponse {
- SecurityControlDefinition: SecurityControlDefinition;
- }
- export interface IcmpTypeCode {
- /**
- * The ICMP code for which to deny or allow access. To deny or allow all codes, use the value -1.
- */
- Code?: Integer;
- /**
- * The ICMP type for which to deny or allow access. To deny or allow all types, use the value -1.
- */
- Type?: Integer;
- }
- export interface ImportFindingsError {
- /**
- * The identifier of the finding that could not be updated.
- */
- Id: NonEmptyString;
- /**
- * The code of the error returned by the BatchImportFindings operation.
- */
- ErrorCode: NonEmptyString;
- /**
- * The message of the error returned by the BatchImportFindings operation.
- */
- ErrorMessage: NonEmptyString;
- }
- export type ImportFindingsErrorList = ImportFindingsError[];
- export interface Insight {
- /**
- * The ARN of a Security Hub insight.
- */
- InsightArn: NonEmptyString;
- /**
- * The name of a Security Hub insight.
- */
- Name: NonEmptyString;
- /**
- * One or more attributes used to filter the findings included in the insight. You can filter by up to ten finding attributes. For each attribute, you can provide up to 20 filter values. The insight only includes findings that match the criteria defined in the filters.
- */
- Filters: AwsSecurityFindingFilters;
- /**
- * The grouping attribute for the insight's findings. Indicates how to group the matching findings, and identifies the type of item that the insight applies to. For example, if an insight is grouped by resource identifier, then the insight produces a list of resource identifiers.
- */
- GroupByAttribute: NonEmptyString;
- }
- export type InsightList = Insight[];
- export interface InsightResultValue {
- /**
- * The value of the attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.
- */
- GroupByAttributeValue: NonEmptyString;
- /**
- * The number of findings returned for each GroupByAttributeValue.
- */
- Count: Integer;
- }
- export type InsightResultValueList = InsightResultValue[];
- export interface InsightResults {
- /**
- * The ARN of the insight whose results are returned by the GetInsightResults operation.
- */
- InsightArn: NonEmptyString;
- /**
- * The attribute that the findings are grouped by for the insight whose results are returned by the GetInsightResults operation.
- */
- GroupByAttribute: NonEmptyString;
- /**
- * The list of insight result values returned by the GetInsightResults operation.
- */
- ResultValues: InsightResultValueList;
- }
- export type Integer = number;
- export interface IntegerConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is an integer.
- */
- DefaultValue?: Integer;
- /**
- * The minimum valid value for a control parameter that is an integer.
- */
- Min?: Integer;
- /**
- * The maximum valid value for a control parameter that is an integer.
- */
- Max?: Integer;
- }
- export type IntegerList = Integer[];
- export interface IntegerListConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is a list of integers.
- */
- DefaultValue?: IntegerList;
- /**
- * The minimum valid value for a control parameter that is a list of integers.
- */
- Min?: Integer;
- /**
- * The maximum valid value for a control parameter that is a list of integers.
- */
- Max?: Integer;
- /**
- * The maximum number of list items that an interger list control parameter can accept.
- */
- MaxItems?: Integer;
- }
- export type IntegrationType = "SEND_FINDINGS_TO_SECURITY_HUB"|"RECEIVE_FINDINGS_FROM_SECURITY_HUB"|"UPDATE_FINDINGS_IN_SECURITY_HUB"|string;
- export type IntegrationTypeList = IntegrationType[];
- export interface Invitation {
- /**
- * The account ID of the Security Hub administrator account that the invitation was sent from.
- */
- AccountId?: AccountId;
- /**
- * The ID of the invitation sent to the member account.
- */
- InvitationId?: NonEmptyString;
- /**
- * The timestamp of when the invitation was sent.
- */
- InvitedAt?: Timestamp;
- /**
- * The current status of the association between the member and administrator accounts.
- */
- MemberStatus?: NonEmptyString;
- }
- export type InvitationList = Invitation[];
- export interface InviteMembersRequest {
- /**
- * The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members.
- */
- AccountIds: AccountIdList;
- }
- export interface InviteMembersResponse {
- /**
- * The list of Amazon Web Services accounts that could not be processed. For each account, the list includes the account ID and the email address.
- */
- UnprocessedAccounts?: ResultList;
- }
- export interface IpFilter {
- /**
- * A finding's CIDR value.
- */
- Cidr?: NonEmptyString;
- }
- export type IpFilterList = IpFilter[];
- export interface IpOrganizationDetails {
- /**
- * The Autonomous System Number (ASN) of the internet provider
- */
- Asn?: Integer;
- /**
- * The name of the organization that registered the ASN.
- */
- AsnOrg?: NonEmptyString;
- /**
- * The ISP information for the internet provider.
- */
- Isp?: NonEmptyString;
- /**
- * The name of the internet provider.
- */
- Org?: NonEmptyString;
- }
- export interface Ipv6CidrBlockAssociation {
- /**
- * The association ID for the IPv6 CIDR block.
- */
- AssociationId?: NonEmptyString;
- /**
- * The IPv6 CIDR block.
- */
- Ipv6CidrBlock?: NonEmptyString;
- /**
- * Information about the state of the CIDR block. Valid values are as follows: associating associated disassociating disassociated failed failing
- */
- CidrBlockState?: NonEmptyString;
- }
- export type Ipv6CidrBlockAssociationList = Ipv6CidrBlockAssociation[];
- export interface KeywordFilter {
- /**
- * A value for the keyword.
- */
- Value?: NonEmptyString;
- }
- export type KeywordFilterList = KeywordFilter[];
- export interface ListAutomationRulesRequest {
- /**
- * A token to specify where to start paginating the response. This is the NextToken from a previously truncated response. On your first call to the ListAutomationRules API, set the value of this parameter to NULL.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of rules to return in the response. This currently ranges from 1 to 100.
- */
- MaxResults?: MaxResults;
- }
- export interface ListAutomationRulesResponse {
- /**
- * Metadata for rules in the calling account. The response includes rules with a RuleStatus of ENABLED and DISABLED.
- */
- AutomationRulesMetadata?: AutomationRulesMetadataList;
- /**
- * A pagination token for the response.
- */
- NextToken?: NextToken;
- }
- export interface ListConfigurationPoliciesRequest {
- /**
- * The NextToken value that's returned from a previous paginated ListConfigurationPolicies request where MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the NextToken value. This value is null when there are no more results to return.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results that's returned by ListConfigurationPolicies in each page of the response. When this parameter is used, ListConfigurationPolicies returns the specified number of results in a single page and a NextToken response element. You can see the remaining results of the initial request by sending another ListConfigurationPolicies request with the returned NextToken value. A valid range for MaxResults is between 1 and 100.
- */
- MaxResults?: MaxResults;
- }
- export interface ListConfigurationPoliciesResponse {
- /**
- * Provides metadata for each of your configuration policies.
- */
- ConfigurationPolicySummaries?: ConfigurationPolicySummaryList;
- /**
- * The NextToken value to include in the next ListConfigurationPolicies request. When the results of a ListConfigurationPolicies request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
- */
- NextToken?: NextToken;
- }
- export interface ListConfigurationPolicyAssociationsRequest {
- /**
- * The NextToken value that's returned from a previous paginated ListConfigurationPolicyAssociations request where MaxResults was used but the results exceeded the value of that parameter. Pagination continues from the end of the previous response that returned the NextToken value. This value is null when there are no more results to return.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results that's returned by ListConfigurationPolicies in each page of the response. When this parameter is used, ListConfigurationPolicyAssociations returns the specified number of results in a single page and a NextToken response element. You can see the remaining results of the initial request by sending another ListConfigurationPolicyAssociations request with the returned NextToken value. A valid range for MaxResults is between 1 and 100.
- */
- MaxResults?: MaxResults;
- /**
- * Options for filtering the ListConfigurationPolicyAssociations response. You can filter by the Amazon Resource Name (ARN) or universally unique identifier (UUID) of a configuration, AssociationType, or AssociationStatus.
- */
- Filters?: AssociationFilters;
- }
- export interface ListConfigurationPolicyAssociationsResponse {
- /**
- * An object that contains the details of each configuration policy association that’s returned in a ListConfigurationPolicyAssociations request.
- */
- ConfigurationPolicyAssociationSummaries?: ConfigurationPolicyAssociationSummaryList;
- /**
- * The NextToken value to include in the next ListConfigurationPolicyAssociations request. When the results of a ListConfigurationPolicyAssociations request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
- */
- NextToken?: NextToken;
- }
- export interface ListEnabledProductsForImportRequest {
- /**
- * The token that is required for pagination. On your first call to the ListEnabledProductsForImport operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of items to return in the response.
- */
- MaxResults?: MaxResults;
- }
- export interface ListEnabledProductsForImportResponse {
- /**
- * The list of ARNs for the resources that represent your subscriptions to products.
- */
- ProductSubscriptions?: ProductSubscriptionArnList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface ListFindingAggregatorsRequest {
- /**
- * The token returned with the previous set of results. Identifies the next set of results to return.
- */
- NextToken?: NextToken;
- /**
- * The maximum number of results to return. This operation currently only returns a single result.
- */
- MaxResults?: MaxResults;
- }
- export interface ListFindingAggregatorsResponse {
- /**
- * The list of finding aggregators. This operation currently only returns a single result.
- */
- FindingAggregators?: FindingAggregatorList;
- /**
- * If there are more results, this is the token to provide in the next call to ListFindingAggregators. This operation currently only returns a single result.
- */
- NextToken?: NextToken;
- }
- export interface ListInvitationsRequest {
- /**
- * The maximum number of items to return in the response.
- */
- MaxResults?: CrossAccountMaxResults;
- /**
- * The token that is required for pagination. On your first call to the ListInvitations operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- }
- export interface ListInvitationsResponse {
- /**
- * The details of the invitations returned by the operation.
- */
- Invitations?: InvitationList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NonEmptyString;
- }
- export interface ListMembersRequest {
- /**
- * Specifies which member accounts to include in the response based on their relationship status with the administrator account. The default value is TRUE. If OnlyAssociated is set to TRUE, the response includes member accounts whose relationship status with the administrator account is set to ENABLED. If OnlyAssociated is set to FALSE, the response includes all existing member accounts.
- */
- OnlyAssociated?: Boolean;
- /**
- * The maximum number of items to return in the response.
- */
- MaxResults?: CrossAccountMaxResults;
- /**
- * The token that is required for pagination. On your first call to the ListMembers operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- }
- export interface ListMembersResponse {
- /**
- * Member details returned by the operation.
- */
- Members?: MemberList;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NonEmptyString;
- }
- export interface ListOrganizationAdminAccountsRequest {
- /**
- * The maximum number of items to return in the response.
- */
- MaxResults?: AdminsMaxResults;
- /**
- * The token that is required for pagination. On your first call to the ListOrganizationAdminAccounts operation, set the value of this parameter to NULL. For subsequent calls to the operation, to continue listing data, set the value of this parameter to the value returned from the previous response.
- */
- NextToken?: NextToken;
- }
- export interface ListOrganizationAdminAccountsResponse {
- /**
- * The list of Security Hub administrator accounts.
- */
- AdminAccounts?: AdminAccounts;
- /**
- * The pagination token to use to request the next page of results.
- */
- NextToken?: NextToken;
- }
- export interface ListSecurityControlDefinitionsRequest {
- /**
- * The Amazon Resource Name (ARN) of the standard that you want to view controls for.
- */
- StandardsArn?: NonEmptyString;
- /**
- * Optional pagination parameter.
- */
- NextToken?: NextToken;
- /**
- * An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 security controls that apply to the specified standard. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 controls. This repeats until all controls for the standard are returned.
- */
- MaxResults?: MaxResults;
- }
- export interface ListSecurityControlDefinitionsResponse {
- /**
- * An array of controls that apply to the specified standard.
- */
- SecurityControlDefinitions: SecurityControlDefinitions;
- /**
- * A pagination parameter that's included in the response only if it was included in the request.
- */
- NextToken?: NextToken;
- }
- export interface ListStandardsControlAssociationsRequest {
- /**
- * The identifier of the control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) that you want to determine the enablement status of in each enabled standard.
- */
- SecurityControlId: NonEmptyString;
- /**
- * Optional pagination parameter.
- */
- NextToken?: NextToken;
- /**
- * An optional parameter that limits the total results of the API response to the specified number. If this parameter isn't provided in the request, the results include the first 25 standard and control associations. The results also include a NextToken parameter that you can use in a subsequent API call to get the next 25 associations. This repeats until all associations for the specified control are returned. The number of results is limited by the number of supported Security Hub standards that you've enabled in the calling account.
- */
- MaxResults?: MaxResults;
- }
- export interface ListStandardsControlAssociationsResponse {
- /**
- * An array that provides the enablement status and other details for each security control that applies to each enabled standard.
- */
- StandardsControlAssociationSummaries: StandardsControlAssociationSummaries;
- /**
- * A pagination parameter that's included in the response only if it was included in the request.
- */
- NextToken?: NextToken;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The ARN of the resource to retrieve tags for.
- */
- ResourceArn: ResourceArn;
- }
- export interface ListTagsForResourceResponse {
- /**
- * The tags associated with a resource.
- */
- Tags?: TagMap;
- }
- export interface LoadBalancerState {
- /**
- * The state code. The initial state of the load balancer is provisioning. After the load balancer is fully set up and ready to route traffic, its state is active. If the load balancer could not be set up, its state is failed.
- */
- Code?: NonEmptyString;
- /**
- * A description of the state.
- */
- Reason?: NonEmptyString;
- }
- export type Long = number;
- export interface Malware {
- /**
- * The name of the malware that was observed.
- */
- Name: NonEmptyString;
- /**
- * The type of the malware that was observed.
- */
- Type?: MalwareType;
- /**
- * The file system path of the malware that was observed.
- */
- Path?: NonEmptyString;
- /**
- * The state of the malware that was observed.
- */
- State?: MalwareState;
- }
- export type MalwareList = Malware[];
- export type MalwareState = "OBSERVED"|"REMOVAL_FAILED"|"REMOVED"|string;
- export type MalwareType = "ADWARE"|"BLENDED_THREAT"|"BOTNET_AGENT"|"COIN_MINER"|"EXPLOIT_KIT"|"KEYLOGGER"|"MACRO"|"POTENTIALLY_UNWANTED"|"SPYWARE"|"RANSOMWARE"|"REMOTE_ACCESS"|"ROOTKIT"|"TROJAN"|"VIRUS"|"WORM"|string;
- export interface MapFilter {
- /**
- * The key of the map filter. For example, for ResourceTags, Key identifies the name of the tag. For UserDefinedFields, Key is the name of the field.
- */
- Key?: NonEmptyString;
- /**
- * The value for the key in the map filter. Filter values are case sensitive. For example, one of the values for a tag called Department might be Security. If you provide security as the filter value, then there's no match.
- */
- Value?: NonEmptyString;
- /**
- * The condition to apply to the key value when filtering Security Hub findings with a map filter. To search for values that have the filter value, use one of the following comparison operators: To search for values that include the filter value, use CONTAINS. For example, for the ResourceTags field, the filter Department CONTAINS Security matches findings that include the value Security for the Department tag. In the same example, a finding with a value of Security team for the Department tag is a match. To search for values that exactly match the filter value, use EQUALS. For example, for the ResourceTags field, the filter Department EQUALS Security matches findings that have the value Security for the Department tag. CONTAINS and EQUALS filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Department CONTAINS Security OR Department CONTAINS Finance match a finding that includes either Security, Finance, or both values. To search for values that don't have the filter value, use one of the following comparison operators: To search for values that exclude the filter value, use NOT_CONTAINS. For example, for the ResourceTags field, the filter Department NOT_CONTAINS Finance matches findings that exclude the value Finance for the Department tag. To search for values other than the filter value, use NOT_EQUALS. For example, for the ResourceTags field, the filter Department NOT_EQUALS Finance matches findings that don’t have the value Finance for the Department tag. NOT_CONTAINS and NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Department NOT_CONTAINS Security AND Department NOT_CONTAINS Finance match a finding that excludes both the Security and Finance values. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters. You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can’t have both an EQUALS filter and a NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub User Guide.
- */
- Comparison?: MapFilterComparison;
- }
- export type MapFilterComparison = "EQUALS"|"NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|string;
- export type MapFilterList = MapFilter[];
- export type MaxResults = number;
- export interface Member {
- /**
- * The Amazon Web Services account ID of the member account.
- */
- AccountId?: AccountId;
- /**
- * The email address of the member account.
- */
- Email?: NonEmptyString;
- /**
- * This is replaced by AdministratorID. The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
- */
- MasterId?: NonEmptyString;
- /**
- * The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.
- */
- AdministratorId?: NonEmptyString;
- /**
- * The status of the relationship between the member account and its administrator account. The status can have one of the following values: Created - Indicates that the administrator account added the member account, but has not yet invited the member account. Invited - Indicates that the administrator account invited the member account. The member account has not yet responded to the invitation. Enabled - Indicates that the member account is currently active. For manually invited member accounts, indicates that the member account accepted the invitation. Removed - Indicates that the administrator account disassociated the member account. Resigned - Indicates that the member account disassociated themselves from the administrator account. Deleted - Indicates that the administrator account deleted the member account. AccountSuspended - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a member account.
- */
- MemberStatus?: NonEmptyString;
- /**
- * A timestamp for the date and time when the invitation was sent to the member account.
- */
- InvitedAt?: Timestamp;
- /**
- * The timestamp for the date and time when the member account was updated.
- */
- UpdatedAt?: Timestamp;
- }
- export type MemberList = Member[];
- export interface Network {
- /**
- * The direction of network traffic associated with a finding.
- */
- Direction?: NetworkDirection;
- /**
- * The protocol of network-related information about a finding.
- */
- Protocol?: NonEmptyString;
- /**
- * The range of open ports that is present on the network.
- */
- OpenPortRange?: PortRange;
- /**
- * The source IPv4 address of network-related information about a finding.
- */
- SourceIpV4?: NonEmptyString;
- /**
- * The source IPv6 address of network-related information about a finding.
- */
- SourceIpV6?: NonEmptyString;
- /**
- * The source port of network-related information about a finding.
- */
- SourcePort?: Integer;
- /**
- * The source domain of network-related information about a finding.
- */
- SourceDomain?: NonEmptyString;
- /**
- * The source media access control (MAC) address of network-related information about a finding.
- */
- SourceMac?: NonEmptyString;
- /**
- * The destination IPv4 address of network-related information about a finding.
- */
- DestinationIpV4?: NonEmptyString;
- /**
- * The destination IPv6 address of network-related information about a finding.
- */
- DestinationIpV6?: NonEmptyString;
- /**
- * The destination port of network-related information about a finding.
- */
- DestinationPort?: Integer;
- /**
- * The destination domain of network-related information about a finding.
- */
- DestinationDomain?: NonEmptyString;
- }
- export interface NetworkConnectionAction {
- /**
- * The direction of the network connection request (IN or OUT).
- */
- ConnectionDirection?: NonEmptyString;
- /**
- * Information about the remote IP address that issued the network connection request.
- */
- RemoteIpDetails?: ActionRemoteIpDetails;
- /**
- * Information about the port on the remote IP address.
- */
- RemotePortDetails?: ActionRemotePortDetails;
- /**
- * Information about the port on the EC2 instance.
- */
- LocalPortDetails?: ActionLocalPortDetails;
- /**
- * The protocol used to make the network connection request.
- */
- Protocol?: NonEmptyString;
- /**
- * Indicates whether the network connection attempt was blocked.
- */
- Blocked?: Boolean;
- }
- export type NetworkDirection = "IN"|"OUT"|string;
- export interface NetworkHeader {
- /**
- * The protocol used for the component.
- */
- Protocol?: NonEmptyString;
- /**
- * Information about the destination of the component.
- */
- Destination?: NetworkPathComponentDetails;
- /**
- * Information about the origin of the component.
- */
- Source?: NetworkPathComponentDetails;
- }
- export interface NetworkPathComponent {
- /**
- * The identifier of a component in the network path.
- */
- ComponentId?: NonEmptyString;
- /**
- * The type of component.
- */
- ComponentType?: NonEmptyString;
- /**
- * Information about the component that comes after the current component in the network path.
- */
- Egress?: NetworkHeader;
- /**
- * Information about the component that comes before the current node in the network path.
- */
- Ingress?: NetworkHeader;
- }
- export interface NetworkPathComponentDetails {
- /**
- * The IP addresses of the destination.
- */
- Address?: StringList;
- /**
- * A list of port ranges for the destination.
- */
- PortRanges?: PortRangeList;
- }
- export type NetworkPathList = NetworkPathComponent[];
- export type NextToken = string;
- export type NonEmptyString = string;
- export type NonEmptyStringList = NonEmptyString[];
- export interface Note {
- /**
- * The text of a note.
- */
- Text: NonEmptyString;
- /**
- * The principal that created a note.
- */
- UpdatedBy: NonEmptyString;
- /**
- * A timestamp that indicates when the note was updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- UpdatedAt: NonEmptyString;
- }
- export interface NoteUpdate {
- /**
- * The updated note text.
- */
- Text: NonEmptyString;
- /**
- * The principal that updated the note.
- */
- UpdatedBy: NonEmptyString;
- }
- export interface NumberFilter {
- /**
- * The greater-than-equal condition to be applied to a single field when querying for findings.
- */
- Gte?: Double;
- /**
- * The less-than-equal condition to be applied to a single field when querying for findings.
- */
- Lte?: Double;
- /**
- * The greater-than condition to be applied to a single field when querying for findings.
- */
- Gt?: Double;
- /**
- * The less-than condition to be applied to a single field when querying for findings.
- */
- Lt?: Double;
- /**
- * The equal-to condition to be applied to a single field when querying for findings.
- */
- Eq?: Double;
- }
- export type NumberFilterList = NumberFilter[];
- export interface Occurrences {
- /**
- * Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
- */
- LineRanges?: Ranges;
- /**
- * Occurrences of sensitive data detected in a binary text file.
- */
- OffsetRanges?: Ranges;
- /**
- * Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.
- */
- Pages?: Pages;
- /**
- * Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.
- */
- Records?: Records;
- /**
- * Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.
- */
- Cells?: Cells;
- }
- export interface OrganizationConfiguration {
- /**
- * Indicates whether the organization uses local or central configuration. If you use local configuration, the Security Hub delegated administrator can set AutoEnable to true and AutoEnableStandards to DEFAULT. This automatically enables Security Hub and default security standards in new organization accounts. These new account settings must be set separately in each Amazon Web Services Region, and settings may be different in each Region. If you use central configuration, the delegated administrator can create configuration policies. Configuration policies can be used to configure Security Hub, security standards, and security controls in multiple accounts and Regions. If you want new organization accounts to use a specific configuration, you can create a configuration policy and associate it with the root or specific organizational units (OUs). New accounts will inherit the policy from the root or their assigned OU.
- */
- ConfigurationType?: OrganizationConfigurationConfigurationType;
- /**
- * Describes whether central configuration could be enabled as the ConfigurationType for the organization. If your ConfigurationType is local configuration, then the value of Status is always ENABLED.
- */
- Status?: OrganizationConfigurationStatus;
- /**
- * Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
- */
- StatusMessage?: NonEmptyString;
- }
- export type OrganizationConfigurationConfigurationType = "CENTRAL"|"LOCAL"|string;
- export type OrganizationConfigurationStatus = "PENDING"|"ENABLED"|"FAILED"|string;
- export interface Page {
- /**
- * The page number of the page that contains the sensitive data.
- */
- PageNumber?: Long;
- /**
- * An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.
- */
- LineRange?: Range;
- /**
- * An occurrence of sensitive data detected in a binary text file.
- */
- OffsetRange?: Range;
- }
- export type Pages = Page[];
- export interface ParameterConfiguration {
- /**
- * Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior. When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field. When ValueType is set equal to CUSTOM, the Value field can't be empty.
- */
- ValueType: ParameterValueType;
- /**
- * The current value of a control parameter.
- */
- Value?: ParameterValue;
- }
- export interface ParameterDefinition {
- /**
- * Description of a control parameter.
- */
- Description: NonEmptyString;
- /**
- * The options for customizing a control parameter. Customization options vary based on the data type of the parameter.
- */
- ConfigurationOptions: ConfigurationOptions;
- }
- export type ParameterDefinitions = {[key: string]: ParameterDefinition};
- export interface ParameterValue {
- /**
- * A control parameter that is an integer.
- */
- Integer?: Integer;
- /**
- * A control parameter that is a list of integers.
- */
- IntegerList?: IntegerList;
- /**
- * A control parameter that is a double.
- */
- Double?: Double;
- /**
- * A control parameter that is a string.
- */
- String?: NonEmptyString;
- /**
- * A control parameter that is a list of strings.
- */
- StringList?: StringList;
- /**
- * A control parameter that is a boolean.
- */
- Boolean?: Boolean;
- /**
- * A control parameter that is an enum.
- */
- Enum?: NonEmptyString;
- /**
- * A control parameter that is a list of enums.
- */
- EnumList?: StringList;
- }
- export type ParameterValueType = "DEFAULT"|"CUSTOM"|string;
- export type Parameters = {[key: string]: ParameterConfiguration};
- export type Partition = "aws"|"aws-cn"|"aws-us-gov"|string;
- export interface PatchSummary {
- /**
- * The identifier of the compliance standard that was used to determine the patch compliance status.
- */
- Id: NonEmptyString;
- /**
- * The number of patches from the compliance standard that were installed successfully.
- */
- InstalledCount?: Integer;
- /**
- * The number of patches that are part of the compliance standard but are not installed. The count includes patches that failed to install.
- */
- MissingCount?: Integer;
- /**
- * The number of patches from the compliance standard that failed to install.
- */
- FailedCount?: Integer;
- /**
- * The number of installed patches that are not part of the compliance standard.
- */
- InstalledOtherCount?: Integer;
- /**
- * The number of patches that are installed but are also on a list of patches that the customer rejected.
- */
- InstalledRejectedCount?: Integer;
- /**
- * The number of patches that were applied, but that require the instance to be rebooted in order to be marked as installed.
- */
- InstalledPendingReboot?: Integer;
- /**
- * Indicates when the operation started. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- OperationStartTime?: NonEmptyString;
- /**
- * Indicates when the operation completed. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- OperationEndTime?: NonEmptyString;
- /**
- * The reboot option specified for the instance.
- */
- RebootOption?: NonEmptyString;
- /**
- * The type of patch operation performed. For Patch Manager, the values are SCAN and INSTALL.
- */
- Operation?: NonEmptyString;
- }
- export interface Policy {
- /**
- * The Amazon Web Service that the configuration policy applies to.
- */
- SecurityHub?: SecurityHubPolicy;
- }
- export interface PortProbeAction {
- /**
- * Information about the ports affected by the port probe.
- */
- PortProbeDetails?: PortProbeDetailList;
- /**
- * Indicates whether the port probe was blocked.
- */
- Blocked?: Boolean;
- }
- export interface PortProbeDetail {
- /**
- * Provides information about the port that was scanned.
- */
- LocalPortDetails?: ActionLocalPortDetails;
- /**
- * Provides information about the IP address where the scanned port is located.
- */
- LocalIpDetails?: ActionLocalIpDetails;
- /**
- * Provides information about the remote IP address that performed the scan.
- */
- RemoteIpDetails?: ActionRemoteIpDetails;
- }
- export type PortProbeDetailList = PortProbeDetail[];
- export interface PortRange {
- /**
- * The first port in the port range.
- */
- Begin?: Integer;
- /**
- * The last port in the port range.
- */
- End?: Integer;
- }
- export interface PortRangeFromTo {
- /**
- * The first port in the port range.
- */
- From?: Integer;
- /**
- * The last port in the port range.
- */
- To?: Integer;
- }
- export type PortRangeList = PortRange[];
- export interface ProcessDetails {
- /**
- * The name of the process.
- */
- Name?: NonEmptyString;
- /**
- * The path to the process executable.
- */
- Path?: NonEmptyString;
- /**
- * The process ID.
- */
- Pid?: Integer;
- /**
- * The parent process ID. This field accepts positive integers between O and 2147483647.
- */
- ParentPid?: Integer;
- /**
- * Indicates when the process was launched. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LaunchedAt?: NonEmptyString;
- /**
- * Indicates when the process was terminated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- TerminatedAt?: NonEmptyString;
- }
- export interface Product {
- /**
- * The ARN assigned to the product.
- */
- ProductArn: NonEmptyString;
- /**
- * The name of the product.
- */
- ProductName?: NonEmptyString;
- /**
- * The name of the company that provides the product.
- */
- CompanyName?: NonEmptyString;
- /**
- * A description of the product.
- */
- Description?: NonEmptyString;
- /**
- * The categories assigned to the product.
- */
- Categories?: CategoryList;
- /**
- * The types of integration that the product supports. Available values are the following. SEND_FINDINGS_TO_SECURITY_HUB - The integration sends findings to Security Hub. RECEIVE_FINDINGS_FROM_SECURITY_HUB - The integration receives findings from Security Hub. UPDATE_FINDINGS_IN_SECURITY_HUB - The integration does not send new findings to Security Hub, but does make updates to the findings that it receives from Security Hub.
- */
- IntegrationTypes?: IntegrationTypeList;
- /**
- * For integrations with Amazon Web Services services, the Amazon Web Services Console URL from which to activate the service. For integrations with third-party products, the Amazon Web Services Marketplace URL from which to subscribe to or purchase the product.
- */
- MarketplaceUrl?: NonEmptyString;
- /**
- * The URL to the service or product documentation about the integration with Security Hub, including how to activate the integration.
- */
- ActivationUrl?: NonEmptyString;
- /**
- * The resource policy associated with the product.
- */
- ProductSubscriptionResourcePolicy?: NonEmptyString;
- }
- export type ProductSubscriptionArnList = NonEmptyString[];
- export type ProductsList = Product[];
- export interface PropagatingVgwSetDetails {
- /**
- * The ID of the virtual private gateway.
- */
- GatewayId?: NonEmptyString;
- }
- export type PropagatingVgwSetList = PropagatingVgwSetDetails[];
- export interface Range {
- /**
- * The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
- */
- Start?: Long;
- /**
- * The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.
- */
- End?: Long;
- /**
- * In the line where the sensitive data starts, the column within the line where the sensitive data starts.
- */
- StartColumn?: Long;
- }
- export type Ranges = Range[];
- export type RatioScale = number;
- export interface Recommendation {
- /**
- * Describes the recommended steps to take to remediate an issue identified in a finding.
- */
- Text?: NonEmptyString;
- /**
- * A URL to a page or site that contains information about how to remediate a finding.
- */
- Url?: NonEmptyString;
- }
- export interface Record {
- /**
- * The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.
- */
- JsonPath?: NonEmptyString;
- /**
- * The record index, starting from 0, for the record that contains the data.
- */
- RecordIndex?: Long;
- }
- export type RecordState = "ACTIVE"|"ARCHIVED"|string;
- export type Records = Record[];
- export type RegionAvailabilityStatus = "AVAILABLE"|"UNAVAILABLE"|string;
- export interface RelatedFinding {
- /**
- * The ARN of the product that generated a related finding.
- */
- ProductArn: NonEmptyString;
- /**
- * The product-generated identifier for a related finding.
- */
- Id: NonEmptyString;
- }
- export type RelatedFindingList = RelatedFinding[];
- export type RelatedRequirementsList = NonEmptyString[];
- export interface Remediation {
- /**
- * A recommendation on the steps to take to remediate the issue identified by a finding.
- */
- Recommendation?: Recommendation;
- }
- export interface Resource {
- /**
- * The type of the resource that details are provided for. If possible, set Type to one of the supported resource types. For example, if the resource is an EC2 instance, then set Type to AwsEc2Instance. If the resource does not match any of the provided types, then set Type to Other.
- */
- Type: NonEmptyString;
- /**
- * The canonical identifier for the given resource type.
- */
- Id: NonEmptyString;
- /**
- * The canonical Amazon Web Services partition name that the Region is assigned to.
- */
- Partition?: Partition;
- /**
- * The canonical Amazon Web Services external Region name where this resource is located.
- */
- Region?: NonEmptyString;
- /**
- * Identifies the role of the resource in the finding. A resource is either the actor or target of the finding activity,
- */
- ResourceRole?: NonEmptyString;
- /**
- * A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
- */
- Tags?: FieldMap;
- /**
- * Contains information about sensitive data that was detected on the resource.
- */
- DataClassification?: DataClassificationDetails;
- /**
- * Additional details about the resource related to a finding.
- */
- Details?: ResourceDetails;
- /**
- * The name of the application that is related to a finding.
- */
- ApplicationName?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the application that is related to a finding.
- */
- ApplicationArn?: NonEmptyString;
- }
- export type ResourceArn = string;
- export interface ResourceDetails {
- /**
- * Details for an autoscaling group.
- */
- AwsAutoScalingAutoScalingGroup?: AwsAutoScalingAutoScalingGroupDetails;
- /**
- * Details for an CodeBuild project.
- */
- AwsCodeBuildProject?: AwsCodeBuildProjectDetails;
- /**
- * Details about a CloudFront distribution.
- */
- AwsCloudFrontDistribution?: AwsCloudFrontDistributionDetails;
- /**
- * Details about an EC2 instance related to a finding.
- */
- AwsEc2Instance?: AwsEc2InstanceDetails;
- /**
- * Details for an EC2 network interface.
- */
- AwsEc2NetworkInterface?: AwsEc2NetworkInterfaceDetails;
- /**
- * Details for an EC2 security group.
- */
- AwsEc2SecurityGroup?: AwsEc2SecurityGroupDetails;
- /**
- * Details for an Amazon EC2 volume.
- */
- AwsEc2Volume?: AwsEc2VolumeDetails;
- /**
- * Details for an Amazon EC2 VPC.
- */
- AwsEc2Vpc?: AwsEc2VpcDetails;
- /**
- * Details about an Elastic IP address.
- */
- AwsEc2Eip?: AwsEc2EipDetails;
- /**
- * Details about a subnet in Amazon EC2.
- */
- AwsEc2Subnet?: AwsEc2SubnetDetails;
- /**
- * Details about an EC2 network access control list (ACL).
- */
- AwsEc2NetworkAcl?: AwsEc2NetworkAclDetails;
- /**
- * Details about a load balancer.
- */
- AwsElbv2LoadBalancer?: AwsElbv2LoadBalancerDetails;
- /**
- * Details about an Elastic Beanstalk environment.
- */
- AwsElasticBeanstalkEnvironment?: AwsElasticBeanstalkEnvironmentDetails;
- /**
- * Details for an Elasticsearch domain.
- */
- AwsElasticsearchDomain?: AwsElasticsearchDomainDetails;
- /**
- * Details about an S3 bucket related to a finding.
- */
- AwsS3Bucket?: AwsS3BucketDetails;
- /**
- * Details about the Amazon S3 Public Access Block configuration for an account.
- */
- AwsS3AccountPublicAccessBlock?: AwsS3AccountPublicAccessBlockDetails;
- /**
- * Details about an S3 object related to a finding.
- */
- AwsS3Object?: AwsS3ObjectDetails;
- /**
- * Details about a Secrets Manager secret.
- */
- AwsSecretsManagerSecret?: AwsSecretsManagerSecretDetails;
- /**
- * Details about an IAM access key related to a finding.
- */
- AwsIamAccessKey?: AwsIamAccessKeyDetails;
- /**
- * Details about an IAM user.
- */
- AwsIamUser?: AwsIamUserDetails;
- /**
- * Details about an IAM permissions policy.
- */
- AwsIamPolicy?: AwsIamPolicyDetails;
- /**
- * Provides information about a version 2 stage for Amazon API Gateway.
- */
- AwsApiGatewayV2Stage?: AwsApiGatewayV2StageDetails;
- /**
- * Provides information about a version 2 API in Amazon API Gateway.
- */
- AwsApiGatewayV2Api?: AwsApiGatewayV2ApiDetails;
- /**
- * Details about a DynamoDB table.
- */
- AwsDynamoDbTable?: AwsDynamoDbTableDetails;
- /**
- * Provides information about a version 1 Amazon API Gateway stage.
- */
- AwsApiGatewayStage?: AwsApiGatewayStageDetails;
- /**
- * Provides information about a REST API in version 1 of Amazon API Gateway.
- */
- AwsApiGatewayRestApi?: AwsApiGatewayRestApiDetails;
- /**
- * Provides details about a CloudTrail trail.
- */
- AwsCloudTrailTrail?: AwsCloudTrailTrailDetails;
- /**
- * Provides information about the state of a patch on an instance based on the patch baseline that was used to patch the instance.
- */
- AwsSsmPatchCompliance?: AwsSsmPatchComplianceDetails;
- /**
- * Provides details about an Certificate Manager certificate.
- */
- AwsCertificateManagerCertificate?: AwsCertificateManagerCertificateDetails;
- /**
- * Contains details about an Amazon Redshift cluster.
- */
- AwsRedshiftCluster?: AwsRedshiftClusterDetails;
- /**
- * Contains details about a Classic Load Balancer.
- */
- AwsElbLoadBalancer?: AwsElbLoadBalancerDetails;
- /**
- * Contains details about an IAM group.
- */
- AwsIamGroup?: AwsIamGroupDetails;
- /**
- * Details about an IAM role.
- */
- AwsIamRole?: AwsIamRoleDetails;
- /**
- * Details about an KMS key.
- */
- AwsKmsKey?: AwsKmsKeyDetails;
- /**
- * Details about a Lambda function.
- */
- AwsLambdaFunction?: AwsLambdaFunctionDetails;
- /**
- * Details for a Lambda layer version.
- */
- AwsLambdaLayerVersion?: AwsLambdaLayerVersionDetails;
- /**
- * Details about an Amazon RDS database instance.
- */
- AwsRdsDbInstance?: AwsRdsDbInstanceDetails;
- /**
- * Details about an SNS topic.
- */
- AwsSnsTopic?: AwsSnsTopicDetails;
- /**
- * Details about an SQS queue.
- */
- AwsSqsQueue?: AwsSqsQueueDetails;
- /**
- * Details for an WAF web ACL.
- */
- AwsWafWebAcl?: AwsWafWebAclDetails;
- /**
- * Details about an Amazon RDS database snapshot.
- */
- AwsRdsDbSnapshot?: AwsRdsDbSnapshotDetails;
- /**
- * Details about an Amazon RDS database cluster snapshot.
- */
- AwsRdsDbClusterSnapshot?: AwsRdsDbClusterSnapshotDetails;
- /**
- * Details about an Amazon RDS database cluster.
- */
- AwsRdsDbCluster?: AwsRdsDbClusterDetails;
- /**
- * Details about an Amazon ECS cluster.
- */
- AwsEcsCluster?: AwsEcsClusterDetails;
- /**
- * Provides information about a Docker container that's part of a task.
- */
- AwsEcsContainer?: AwsEcsContainerDetails;
- /**
- * Details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.
- */
- AwsEcsTaskDefinition?: AwsEcsTaskDefinitionDetails;
- /**
- * Details about a container resource related to a finding.
- */
- Container?: ContainerDetails;
- /**
- * Details about a resource that are not available in a type-specific details object. Use the Other object in the following cases. The type-specific object does not contain all of the fields that you want to populate. In this case, first use the type-specific object to populate those fields. Use the Other object to populate the fields that are missing from the type-specific object. The resource type does not have a corresponding object. This includes resources for which the type is Other.
- */
- Other?: FieldMap;
- /**
- * Details about an RDS event notification subscription.
- */
- AwsRdsEventSubscription?: AwsRdsEventSubscriptionDetails;
- /**
- * Details about a service within an ECS cluster.
- */
- AwsEcsService?: AwsEcsServiceDetails;
- /**
- * Provides details about a launch configuration.
- */
- AwsAutoScalingLaunchConfiguration?: AwsAutoScalingLaunchConfigurationDetails;
- /**
- * Details about an Amazon EC2 VPN connection.
- */
- AwsEc2VpnConnection?: AwsEc2VpnConnectionDetails;
- /**
- * Information about an Amazon ECR image.
- */
- AwsEcrContainerImage?: AwsEcrContainerImageDetails;
- /**
- * Details about an Amazon OpenSearch Service domain.
- */
- AwsOpenSearchServiceDomain?: AwsOpenSearchServiceDomainDetails;
- /**
- * Details about the service configuration for a VPC endpoint service.
- */
- AwsEc2VpcEndpointService?: AwsEc2VpcEndpointServiceDetails;
- /**
- * Information about the encryption configuration for X-Ray.
- */
- AwsXrayEncryptionConfig?: AwsXrayEncryptionConfigDetails;
- /**
- * Details about a rate-based rule for global resources.
- */
- AwsWafRateBasedRule?: AwsWafRateBasedRuleDetails;
- /**
- * Details about a rate-based rule for Regional resources.
- */
- AwsWafRegionalRateBasedRule?: AwsWafRegionalRateBasedRuleDetails;
- /**
- * Information about an Amazon Elastic Container Registry repository.
- */
- AwsEcrRepository?: AwsEcrRepositoryDetails;
- /**
- * Details about an Amazon EKS cluster.
- */
- AwsEksCluster?: AwsEksClusterDetails;
- /**
- * Details about an Network Firewall firewall policy.
- */
- AwsNetworkFirewallFirewallPolicy?: AwsNetworkFirewallFirewallPolicyDetails;
- /**
- * Details about an Network Firewall firewall.
- */
- AwsNetworkFirewallFirewall?: AwsNetworkFirewallFirewallDetails;
- /**
- * Details about an Network Firewall rule group.
- */
- AwsNetworkFirewallRuleGroup?: AwsNetworkFirewallRuleGroupDetails;
- /**
- * Details about an Amazon RDS DB security group.
- */
- AwsRdsDbSecurityGroup?: AwsRdsDbSecurityGroupDetails;
- /**
- * Details about an Amazon Kinesis data stream.
- */
- AwsKinesisStream?: AwsKinesisStreamDetails;
- /**
- * Details about an Amazon EC2 transit gateway that interconnects your virtual private clouds (VPC) and on-premises networks.
- */
- AwsEc2TransitGateway?: AwsEc2TransitGatewayDetails;
- /**
- * Details about an Amazon EFS access point. An access point is an application-specific view into an EFS file system that applies an operating system user and group, and a file system path, to any file system request made through the access point.
- */
- AwsEfsAccessPoint?: AwsEfsAccessPointDetails;
- /**
- * Details about an CloudFormation stack. A stack is a collection of Amazon Web Services resources that you can manage as a single unit.
- */
- AwsCloudFormationStack?: AwsCloudFormationStackDetails;
- /**
- * Details about an Amazon CloudWatch alarm. An alarm allows you to monitor and receive alerts about your Amazon Web Services resources and applications across multiple Regions.
- */
- AwsCloudWatchAlarm?: AwsCloudWatchAlarmDetails;
- /**
- * Details about an Amazon EC2 VPC peering connection. A VPC peering connection is a networking connection between two VPCs that enables you to route traffic between them privately.
- */
- AwsEc2VpcPeeringConnection?: AwsEc2VpcPeeringConnectionDetails;
- /**
- * Details about an WAF rule group for Regional resources.
- */
- AwsWafRegionalRuleGroup?: AwsWafRegionalRuleGroupDetails;
- /**
- * Details about an WAF rule for Regional resources.
- */
- AwsWafRegionalRule?: AwsWafRegionalRuleDetails;
- /**
- * Details about an WAF web access control list (web ACL) for Regional resources.
- */
- AwsWafRegionalWebAcl?: AwsWafRegionalWebAclDetails;
- /**
- * Details about an WAF rule for global resources.
- */
- AwsWafRule?: AwsWafRuleDetails;
- /**
- * Details about an WAF rule group for global resources.
- */
- AwsWafRuleGroup?: AwsWafRuleGroupDetails;
- /**
- * Details about a task in a cluster.
- */
- AwsEcsTask?: AwsEcsTaskDetails;
- /**
- * Provides details about an Backup backup vault.
- */
- AwsBackupBackupVault?: AwsBackupBackupVaultDetails;
- /**
- * Provides details about an Backup backup plan.
- */
- AwsBackupBackupPlan?: AwsBackupBackupPlanDetails;
- /**
- * Provides details about an Backup backup, or recovery point.
- */
- AwsBackupRecoveryPoint?: AwsBackupRecoveryPointDetails;
- AwsEc2LaunchTemplate?: AwsEc2LaunchTemplateDetails;
- AwsSageMakerNotebookInstance?: AwsSageMakerNotebookInstanceDetails;
- AwsWafv2WebAcl?: AwsWafv2WebAclDetails;
- AwsWafv2RuleGroup?: AwsWafv2RuleGroupDetails;
- /**
- * Provides details about a route table. A route table contains a set of rules, called routes, that determine where to direct network traffic from your subnet or gateway.
- */
- AwsEc2RouteTable?: AwsEc2RouteTableDetails;
- /**
- * Provides details about AppSync message broker. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
- */
- AwsAmazonMqBroker?: AwsAmazonMqBrokerDetails;
- /**
- * Provides details about an AppSync Graph QL API, which lets you query multiple databases, microservices, and APIs from a single GraphQL endpoint.
- */
- AwsAppSyncGraphQlApi?: AwsAppSyncGraphQlApiDetails;
- /**
- * A schema defines the structure of events that are sent to Amazon EventBridge. Schema registries are containers for schemas. They collect and organize schemas so that your schemas are in logical groups.
- */
- AwsEventSchemasRegistry?: AwsEventSchemasRegistryDetails;
- /**
- * Provides details about an Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector is required for GuardDuty to become operational.
- */
- AwsGuardDutyDetector?: AwsGuardDutyDetectorDetails;
- /**
- * Provides details about an Step Functions state machine, which is a workflow consisting of a series of event-driven steps.
- */
- AwsStepFunctionStateMachine?: AwsStepFunctionStateMachineDetails;
- /**
- * Provides information about an Amazon Athena workgroup. A workgroup helps you separate users, teams, applications, or workloads. It also helps you set limits on data processing and track costs.
- */
- AwsAthenaWorkGroup?: AwsAthenaWorkGroupDetails;
- /**
- * Provides details about Amazon EventBridge event bus for an endpoint. An event bus is a router that receives events and delivers them to zero or more destinations, or targets.
- */
- AwsEventsEventbus?: AwsEventsEventbusDetails;
- /**
- * Provides details about an Database Migration Service (DMS) endpoint. An endpoint provides connection, data store type, and location information about your data store.
- */
- AwsDmsEndpoint?: AwsDmsEndpointDetails;
- /**
- * Provides details about an Amazon EventBridge global endpoint. The endpoint can improve your application’s availability by making it Regional-fault tolerant.
- */
- AwsEventsEndpoint?: AwsEventsEndpointDetails;
- /**
- * Provides details about an DMS replication task. A replication task moves a set of data from the source endpoint to the target endpoint.
- */
- AwsDmsReplicationTask?: AwsDmsReplicationTaskDetails;
- /**
- * Provides details about an DMS replication instance. DMS uses a replication instance to connect to your source data store, read the source data, and format the data for consumption by the target data store.
- */
- AwsDmsReplicationInstance?: AwsDmsReplicationInstanceDetails;
- /**
- * Provides details about an Amazon Route 53 hosted zone, including the four name servers assigned to the hosted zone. A hosted zone represents a collection of records that can be managed together, belonging to a single parent domain name.
- */
- AwsRoute53HostedZone?: AwsRoute53HostedZoneDetails;
- /**
- * Provides details about an Amazon Managed Streaming for Apache Kafka (Amazon MSK) cluster.
- */
- AwsMskCluster?: AwsMskClusterDetails;
- /**
- * Provides details about an Amazon Simple Storage Service (Amazon S3) access point. S3 access points are named network endpoints that are attached to S3 buckets that you can use to perform S3 object operations.
- */
- AwsS3AccessPoint?: AwsS3AccessPointDetails;
- /**
- * Provides details about an Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.
- */
- AwsEc2ClientVpnEndpoint?: AwsEc2ClientVpnEndpointDetails;
- }
- export type ResourceList = Resource[];
- export interface Result {
- /**
- * An Amazon Web Services account ID of the account that was not processed.
- */
- AccountId?: AccountId;
- /**
- * The reason that the account was not processed.
- */
- ProcessingResult?: NonEmptyString;
- }
- export type ResultList = Result[];
- export interface RouteSetDetails {
- /**
- * The ID of the carrier gateway.
- */
- CarrierGatewayId?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the core network.
- */
- CoreNetworkArn?: NonEmptyString;
- /**
- * The IPv4 CIDR block used for the destination match.
- */
- DestinationCidrBlock?: NonEmptyString;
- /**
- * The IPv6 CIDR block used for the destination match.
- */
- DestinationIpv6CidrBlock?: NonEmptyString;
- /**
- * The prefix of the destination Amazon Web Service.
- */
- DestinationPrefixListId?: NonEmptyString;
- /**
- * The ID of the egress-only internet gateway.
- */
- EgressOnlyInternetGatewayId?: NonEmptyString;
- /**
- * The ID of a gateway attached to your VPC.
- */
- GatewayId?: NonEmptyString;
- /**
- * The ID of a NAT instance in your VPC.
- */
- InstanceId?: NonEmptyString;
- /**
- * The ID of the Amazon Web Services account that owns the instance.
- */
- InstanceOwnerId?: NonEmptyString;
- /**
- * The ID of the local gateway.
- */
- LocalGatewayId?: NonEmptyString;
- /**
- * The ID of a NAT gateway.
- */
- NatGatewayId?: NonEmptyString;
- /**
- * The ID of the network interface.
- */
- NetworkInterfaceId?: NonEmptyString;
- /**
- * Describes how the route was created.
- */
- Origin?: NonEmptyString;
- /**
- * The state of the route.
- */
- State?: NonEmptyString;
- /**
- * The ID of a transit gateway.
- */
- TransitGatewayId?: NonEmptyString;
- /**
- * The ID of a VPC peering connection.
- */
- VpcPeeringConnectionId?: NonEmptyString;
- }
- export type RouteSetList = RouteSetDetails[];
- export interface RuleGroupDetails {
- /**
- * Additional settings to use in the specified rules.
- */
- RuleVariables?: RuleGroupVariables;
- /**
- * The rules and actions for the rule group. For stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules. For stateless rule groups, contains StatelessRulesAndCustomActions.
- */
- RulesSource?: RuleGroupSource;
- }
- export interface RuleGroupSource {
- /**
- * Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.
- */
- RulesSourceList?: RuleGroupSourceListDetails;
- /**
- * Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
- */
- RulesString?: NonEmptyString;
- /**
- * Suricata rule specifications.
- */
- StatefulRules?: RuleGroupSourceStatefulRulesList;
- /**
- * The stateless rules and custom actions used by a stateless rule group.
- */
- StatelessRulesAndCustomActions?: RuleGroupSourceStatelessRulesAndCustomActionsDetails;
- }
- export interface RuleGroupSourceCustomActionsDetails {
- /**
- * The definition of a custom action.
- */
- ActionDefinition?: StatelessCustomActionDefinition;
- /**
- * A descriptive name of the custom action.
- */
- ActionName?: NonEmptyString;
- }
- export type RuleGroupSourceCustomActionsList = RuleGroupSourceCustomActionsDetails[];
- export interface RuleGroupSourceListDetails {
- /**
- * Indicates whether to allow or deny access to the domains listed in Targets.
- */
- GeneratedRulesType?: NonEmptyString;
- /**
- * The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.
- */
- TargetTypes?: NonEmptyStringList;
- /**
- * The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.' prefix as a wildcard. For example, .example.com matches all domains that end with example.com.
- */
- Targets?: NonEmptyStringList;
- }
- export interface RuleGroupSourceStatefulRulesDetails {
- /**
- * Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
- */
- Action?: NonEmptyString;
- /**
- * The stateful inspection criteria for the rule.
- */
- Header?: RuleGroupSourceStatefulRulesHeaderDetails;
- /**
- * Additional options for the rule.
- */
- RuleOptions?: RuleGroupSourceStatefulRulesOptionsList;
- }
- export interface RuleGroupSourceStatefulRulesHeaderDetails {
- /**
- * The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
- */
- Destination?: NonEmptyString;
- /**
- * The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.
- */
- DestinationPort?: NonEmptyString;
- /**
- * The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.
- */
- Direction?: NonEmptyString;
- /**
- * The protocol to inspect for. To inspector for all protocols, use IP.
- */
- Protocol?: NonEmptyString;
- /**
- * The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
- */
- Source?: NonEmptyString;
- /**
- * The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.
- */
- SourcePort?: NonEmptyString;
- }
- export type RuleGroupSourceStatefulRulesList = RuleGroupSourceStatefulRulesDetails[];
- export interface RuleGroupSourceStatefulRulesOptionsDetails {
- /**
- * A keyword to look for.
- */
- Keyword?: NonEmptyString;
- /**
- * A list of settings.
- */
- Settings?: RuleGroupSourceStatefulRulesRuleOptionsSettingsList;
- }
- export type RuleGroupSourceStatefulRulesOptionsList = RuleGroupSourceStatefulRulesOptionsDetails[];
- export type RuleGroupSourceStatefulRulesRuleOptionsSettingsList = NonEmptyString[];
- export interface RuleGroupSourceStatelessRuleDefinition {
- /**
- * The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You can then add custom actions.
- */
- Actions?: NonEmptyStringList;
- /**
- * The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.
- */
- MatchAttributes?: RuleGroupSourceStatelessRuleMatchAttributes;
- }
- export interface RuleGroupSourceStatelessRuleMatchAttributes {
- /**
- * A list of port ranges to specify the destination ports to inspect for.
- */
- DestinationPorts?: RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList;
- /**
- * The destination IP addresses and address ranges to inspect for, in CIDR notation.
- */
- Destinations?: RuleGroupSourceStatelessRuleMatchAttributesDestinationsList;
- /**
- * The protocols to inspect for.
- */
- Protocols?: RuleGroupSourceStatelessRuleMatchAttributesProtocolsList;
- /**
- * A list of port ranges to specify the source ports to inspect for.
- */
- SourcePorts?: RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList;
- /**
- * The source IP addresses and address ranges to inspect for, in CIDR notation.
- */
- Sources?: RuleGroupSourceStatelessRuleMatchAttributesSourcesList;
- /**
- * The TCP flags and masks to inspect for.
- */
- TcpFlags?: RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList;
- }
- export interface RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts {
- /**
- * The starting port value for the port range.
- */
- FromPort?: Integer;
- /**
- * The ending port value for the port range.
- */
- ToPort?: Integer;
- }
- export type RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList = RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts[];
- export interface RuleGroupSourceStatelessRuleMatchAttributesDestinations {
- /**
- * An IP address or a block of IP addresses.
- */
- AddressDefinition?: NonEmptyString;
- }
- export type RuleGroupSourceStatelessRuleMatchAttributesDestinationsList = RuleGroupSourceStatelessRuleMatchAttributesDestinations[];
- export type RuleGroupSourceStatelessRuleMatchAttributesProtocolsList = Integer[];
- export interface RuleGroupSourceStatelessRuleMatchAttributesSourcePorts {
- /**
- * The starting port value for the port range.
- */
- FromPort?: Integer;
- /**
- * The ending port value for the port range.
- */
- ToPort?: Integer;
- }
- export type RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList = RuleGroupSourceStatelessRuleMatchAttributesSourcePorts[];
- export interface RuleGroupSourceStatelessRuleMatchAttributesSources {
- /**
- * An IP address or a block of IP addresses.
- */
- AddressDefinition?: NonEmptyString;
- }
- export type RuleGroupSourceStatelessRuleMatchAttributesSourcesList = RuleGroupSourceStatelessRuleMatchAttributesSources[];
- export interface RuleGroupSourceStatelessRuleMatchAttributesTcpFlags {
- /**
- * Defines the flags from the Masks setting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.
- */
- Flags?: NonEmptyStringList;
- /**
- * The set of flags to consider in the inspection. If not specified, then all flags are inspected.
- */
- Masks?: NonEmptyStringList;
- }
- export type RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList = RuleGroupSourceStatelessRuleMatchAttributesTcpFlags[];
- export interface RuleGroupSourceStatelessRulesAndCustomActionsDetails {
- /**
- * Custom actions for the rule group.
- */
- CustomActions?: RuleGroupSourceCustomActionsList;
- /**
- * Stateless rules for the rule group.
- */
- StatelessRules?: RuleGroupSourceStatelessRulesList;
- }
- export interface RuleGroupSourceStatelessRulesDetails {
- /**
- * Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.
- */
- Priority?: Integer;
- /**
- * Provides the definition of the stateless rule.
- */
- RuleDefinition?: RuleGroupSourceStatelessRuleDefinition;
- }
- export type RuleGroupSourceStatelessRulesList = RuleGroupSourceStatelessRulesDetails[];
- export interface RuleGroupVariables {
- /**
- * A list of IP addresses and address ranges, in CIDR notation.
- */
- IpSets?: RuleGroupVariablesIpSetsDetails;
- /**
- * A list of port ranges.
- */
- PortSets?: RuleGroupVariablesPortSetsDetails;
- }
- export interface RuleGroupVariablesIpSetsDetails {
- /**
- * The list of IP addresses and ranges.
- */
- Definition?: NonEmptyStringList;
- }
- export interface RuleGroupVariablesPortSetsDetails {
- /**
- * The list of port ranges.
- */
- Definition?: NonEmptyStringList;
- }
- export type RuleOrderValue = number;
- export type RuleStatus = "ENABLED"|"DISABLED"|string;
- export interface SecurityControl {
- /**
- * The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) for a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.
- */
- SecurityControlArn: NonEmptyString;
- /**
- * The title of a security control.
- */
- Title: NonEmptyString;
- /**
- * The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
- */
- Description: NonEmptyString;
- /**
- * A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
- */
- RemediationUrl: NonEmptyString;
- /**
- * The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
- */
- SeverityRating: SeverityRating;
- /**
- * The enablement status of a security control in a specific standard.
- */
- SecurityControlStatus: ControlStatus;
- /**
- * Identifies whether customizable properties of a security control are reflected in Security Hub findings. A status of READY indicates findings include the current parameter values. A status of UPDATING indicates that all findings may not include the current parameter values.
- */
- UpdateStatus?: UpdateStatus;
- /**
- * An object that identifies the name of a control parameter, its current value, and whether it has been customized.
- */
- Parameters?: Parameters;
- /**
- * The most recent reason for updating the customizable properties of a security control. This differs from the UpdateReason field of the BatchUpdateStandardsControlAssociations API, which tracks the reason for updating the enablement status of a control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- */
- LastUpdateReason?: AlphaNumericNonEmptyString;
- }
- export interface SecurityControlCustomParameter {
- /**
- * The ID of the security control.
- */
- SecurityControlId?: NonEmptyString;
- /**
- * An object that specifies parameter values for a control in a configuration policy.
- */
- Parameters?: Parameters;
- }
- export type SecurityControlCustomParametersList = SecurityControlCustomParameter[];
- export interface SecurityControlDefinition {
- /**
- * The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number (for example, APIGateway.3). This parameter differs from SecurityControlArn, which is a unique Amazon Resource Name (ARN) assigned to a control. The ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
- */
- SecurityControlId: NonEmptyString;
- /**
- * The title of a security control.
- */
- Title: NonEmptyString;
- /**
- * The description of a security control across standards. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter doesn't reference a specific standard.
- */
- Description: NonEmptyString;
- /**
- * A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
- */
- RemediationUrl: NonEmptyString;
- /**
- * The severity of a security control. For more information about how Security Hub determines control severity, see Assigning severity to control findings in the Security Hub User Guide.
- */
- SeverityRating: SeverityRating;
- /**
- * Specifies whether a security control is available in the current Amazon Web Services Region.
- */
- CurrentRegionAvailability: RegionAvailabilityStatus;
- /**
- * Security control properties that you can customize. Currently, only parameter customization is supported for select controls. An empty array is returned for controls that don’t support custom properties.
- */
- CustomizableProperties?: CustomizableProperties;
- /**
- * An object that provides a security control parameter name, description, and the options for customizing it. This object is excluded for a control that doesn't support custom parameters.
- */
- ParameterDefinitions?: ParameterDefinitions;
- }
- export type SecurityControlDefinitions = SecurityControlDefinition[];
- export interface SecurityControlParameter {
- /**
- * The name of a
- */
- Name?: NonEmptyString;
- /**
- * The current value of a control parameter.
- */
- Value?: TypeList;
- }
- export type SecurityControlParametersList = SecurityControlParameter[];
- export type SecurityControlProperty = "Parameters"|string;
- export type SecurityControls = SecurityControl[];
- export interface SecurityControlsConfiguration {
- /**
- * A list of security controls that are enabled in the configuration policy. Security Hub disables all other controls (including newly released controls) other than the listed controls.
- */
- EnabledSecurityControlIdentifiers?: EnabledSecurityControlIdentifierList;
- /**
- * A list of security controls that are disabled in the configuration policy. Security Hub enables all other controls (including newly released controls) other than the listed controls.
- */
- DisabledSecurityControlIdentifiers?: DisabledSecurityControlIdentifierList;
- /**
- * A list of security controls and control parameter values that are included in a configuration policy.
- */
- SecurityControlCustomParameters?: SecurityControlCustomParametersList;
- }
- export type SecurityGroups = NonEmptyString[];
- export interface SecurityHubPolicy {
- /**
- * Indicates whether Security Hub is enabled in the policy.
- */
- ServiceEnabled?: Boolean;
- /**
- * A list that defines which security standards are enabled in the configuration policy.
- */
- EnabledStandardIdentifiers?: EnabledStandardIdentifierList;
- /**
- * An object that defines which security controls are enabled in the configuration policy. The enablement status of a control is aligned across all of the enabled standards in an account.
- */
- SecurityControlsConfiguration?: SecurityControlsConfiguration;
- }
- export interface SensitiveDataDetections {
- /**
- * The total number of occurrences of sensitive data that were detected.
- */
- Count?: Long;
- /**
- * The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.
- */
- Type?: NonEmptyString;
- /**
- * Details about the sensitive data that was detected.
- */
- Occurrences?: Occurrences;
- }
- export type SensitiveDataDetectionsList = SensitiveDataDetections[];
- export interface SensitiveDataResult {
- /**
- * The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.
- */
- Category?: NonEmptyString;
- /**
- * The list of detected instances of sensitive data.
- */
- Detections?: SensitiveDataDetectionsList;
- /**
- * The total number of occurrences of sensitive data.
- */
- TotalCount?: Long;
- }
- export type SensitiveDataResultList = SensitiveDataResult[];
- export interface Severity {
- /**
- * Deprecated. This attribute isn't included in findings. Instead of providing Product, provide Original. The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.
- */
- Product?: Double;
- /**
- * The severity value of the finding. The allowed values are the following. INFORMATIONAL - No issue was found. LOW - The issue does not require action on its own. MEDIUM - The issue must be addressed but not urgently. HIGH - The issue must be addressed as a priority. CRITICAL - The issue must be remediated immediately to avoid it escalating. If you provide Normalized and do not provide Label, then Label is set automatically as follows. 0 - INFORMATIONAL 1–39 - LOW 40–69 - MEDIUM 70–89 - HIGH 90–100 - CRITICAL
- */
- Label?: SeverityLabel;
- /**
- * Deprecated. The normalized severity of a finding. Instead of providing Normalized, provide Label. If you provide Label and do not provide Normalized, then Normalized is set automatically as follows. INFORMATIONAL - 0 LOW - 1 MEDIUM - 40 HIGH - 70 CRITICAL - 90
- */
- Normalized?: Integer;
- /**
- * The native severity from the finding product that generated the finding.
- */
- Original?: NonEmptyString;
- }
- export type SeverityLabel = "INFORMATIONAL"|"LOW"|"MEDIUM"|"HIGH"|"CRITICAL"|string;
- export type SeverityRating = "LOW"|"MEDIUM"|"HIGH"|"CRITICAL"|string;
- export interface SeverityUpdate {
- /**
- * The normalized severity for the finding. This attribute is to be deprecated in favor of Label. If you provide Normalized and do not provide Label, Label is set automatically as follows. 0 - INFORMATIONAL 1–39 - LOW 40–69 - MEDIUM 70–89 - HIGH 90–100 - CRITICAL
- */
- Normalized?: RatioScale;
- /**
- * The native severity as defined by the Amazon Web Services service or integrated partner product that generated the finding.
- */
- Product?: Double;
- /**
- * The severity value of the finding. The allowed values are the following. INFORMATIONAL - No issue was found. LOW - The issue does not require action on its own. MEDIUM - The issue must be addressed but not urgently. HIGH - The issue must be addressed as a priority. CRITICAL - The issue must be remediated immediately to avoid it escalating.
- */
- Label?: SeverityLabel;
- }
- export type SizeBytes = number;
- export interface SoftwarePackage {
- /**
- * The name of the software package.
- */
- Name?: NonEmptyString;
- /**
- * The version of the software package.
- */
- Version?: NonEmptyString;
- /**
- * The epoch of the software package.
- */
- Epoch?: NonEmptyString;
- /**
- * The release of the software package.
- */
- Release?: NonEmptyString;
- /**
- * The architecture used for the software package.
- */
- Architecture?: NonEmptyString;
- /**
- * The source of the package.
- */
- PackageManager?: NonEmptyString;
- /**
- * The file system path to the package manager inventory file.
- */
- FilePath?: NonEmptyString;
- /**
- * The version of the software package in which the vulnerability has been resolved.
- */
- FixedInVersion?: NonEmptyString;
- /**
- * Describes the actions a customer can take to resolve the vulnerability in the software package.
- */
- Remediation?: NonEmptyString;
- /**
- * The source layer hash of the vulnerable package.
- */
- SourceLayerHash?: NonEmptyString;
- /**
- * The Amazon Resource Name (ARN) of the source layer.
- */
- SourceLayerArn?: NonEmptyString;
- }
- export type SoftwarePackageList = SoftwarePackage[];
- export type SortCriteria = SortCriterion[];
- export interface SortCriterion {
- /**
- * The finding attribute used to sort findings.
- */
- Field?: NonEmptyString;
- /**
- * The order used to sort findings.
- */
- SortOrder?: SortOrder;
- }
- export type SortOrder = "asc"|"desc"|string;
- export interface Standard {
- /**
- * The ARN of a standard.
- */
- StandardsArn?: NonEmptyString;
- /**
- * The name of the standard.
- */
- Name?: NonEmptyString;
- /**
- * A description of the standard.
- */
- Description?: NonEmptyString;
- /**
- * Whether the standard is enabled by default. When Security Hub is enabled from the console, if a standard is enabled by default, the check box for that standard is selected by default. When Security Hub is enabled using the EnableSecurityHub API operation, the standard is enabled by default unless EnableDefaultStandards is set to false.
- */
- EnabledByDefault?: Boolean;
- /**
- * Provides details about the management of a standard.
- */
- StandardsManagedBy?: StandardsManagedBy;
- }
- export type Standards = Standard[];
- export interface StandardsControl {
- /**
- * The ARN of the security standard control.
- */
- StandardsControlArn?: NonEmptyString;
- /**
- * The current status of the security standard control. Indicates whether the control is enabled or disabled. Security Hub does not check against disabled controls.
- */
- ControlStatus?: ControlStatus;
- /**
- * The reason provided for the most recent change in status for the control.
- */
- DisabledReason?: NonEmptyString;
- /**
- * The date and time that the status of the security standard control was most recently updated.
- */
- ControlStatusUpdatedAt?: Timestamp;
- /**
- * The identifier of the security standard control.
- */
- ControlId?: NonEmptyString;
- /**
- * The title of the security standard control.
- */
- Title?: NonEmptyString;
- /**
- * The longer description of the security standard control. Provides information about what the control is checking for.
- */
- Description?: NonEmptyString;
- /**
- * A link to remediation information for the control in the Security Hub user documentation.
- */
- RemediationUrl?: NonEmptyString;
- /**
- * The severity of findings generated from this security standard control. The finding severity is based on an assessment of how easy it would be to compromise Amazon Web Services resources if the issue is detected.
- */
- SeverityRating?: SeverityRating;
- /**
- * The list of requirements that are related to this control.
- */
- RelatedRequirements?: RelatedRequirementsList;
- }
- export type StandardsControlArnList = NonEmptyString[];
- export interface StandardsControlAssociationDetail {
- /**
- * The Amazon Resource Name (ARN) of a security standard.
- */
- StandardsArn: NonEmptyString;
- /**
- * The unique identifier of a security control across standards. Values for this field typically consist of an Amazon Web Service name and a number, such as APIGateway.3.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The ARN of a security control across standards, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.
- */
- SecurityControlArn: NonEmptyString;
- /**
- * Specifies whether a control is enabled or disabled in a specified standard.
- */
- AssociationStatus: AssociationStatus;
- /**
- * The requirement that underlies a control in the compliance framework related to the standard.
- */
- RelatedRequirements?: RelatedRequirementsList;
- /**
- * The time at which the enablement status of the control in the specified standard was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The reason for updating the enablement status of a control in a specified standard.
- */
- UpdatedReason?: NonEmptyString;
- /**
- * The title of a control. This field may reference a specific standard.
- */
- StandardsControlTitle?: NonEmptyString;
- /**
- * The description of a control. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. This parameter may reference a specific standard.
- */
- StandardsControlDescription?: NonEmptyString;
- /**
- * Provides the input parameter that Security Hub uses to call the UpdateStandardsControl API. This API can be used to enable or disable a control in a specified standard.
- */
- StandardsControlArns?: StandardsControlArnList;
- }
- export type StandardsControlAssociationDetails = StandardsControlAssociationDetail[];
- export interface StandardsControlAssociationId {
- /**
- * The unique identifier (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) of a security control across standards.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The ARN of a standard.
- */
- StandardsArn: NonEmptyString;
- }
- export type StandardsControlAssociationIds = StandardsControlAssociationId[];
- export type StandardsControlAssociationSummaries = StandardsControlAssociationSummary[];
- export interface StandardsControlAssociationSummary {
- /**
- * The Amazon Resource Name (ARN) of a standard.
- */
- StandardsArn: NonEmptyString;
- /**
- * A unique standard-agnostic identifier for a control. Values for this field typically consist of an Amazon Web Service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The ARN of a control, such as arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1. This parameter doesn't mention a specific standard.
- */
- SecurityControlArn: NonEmptyString;
- /**
- * The enablement status of a control in a specific standard.
- */
- AssociationStatus: AssociationStatus;
- /**
- * The requirement that underlies this control in the compliance framework related to the standard.
- */
- RelatedRequirements?: RelatedRequirementsList;
- /**
- * The last time that a control's enablement status in a specified standard was updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The reason for updating a control's enablement status in a specified standard.
- */
- UpdatedReason?: NonEmptyString;
- /**
- * The title of a control.
- */
- StandardsControlTitle?: NonEmptyString;
- /**
- * The description of a control. This typically summarizes how Security Hub evaluates the control and the conditions under which it produces a failed finding. The parameter may reference a specific standard.
- */
- StandardsControlDescription?: NonEmptyString;
- }
- export interface StandardsControlAssociationUpdate {
- /**
- * The Amazon Resource Name (ARN) of the standard in which you want to update the control's enablement status.
- */
- StandardsArn: NonEmptyString;
- /**
- * The unique identifier for the security control whose enablement status you want to update.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The desired enablement status of the control in the standard.
- */
- AssociationStatus: AssociationStatus;
- /**
- * The reason for updating the control's enablement status in the standard.
- */
- UpdatedReason?: NonEmptyString;
- }
- export type StandardsControlAssociationUpdates = StandardsControlAssociationUpdate[];
- export type StandardsControls = StandardsControl[];
- export type StandardsInputParameterMap = {[key: string]: NonEmptyString};
- export interface StandardsManagedBy {
- /**
- * An identifier for the company that manages a specific security standard. For existing standards, the value is equal to Amazon Web Services.
- */
- Company?: NonEmptyString;
- /**
- * An identifier for the product that manages a specific security standard. For existing standards, the value is equal to the Amazon Web Services service that manages the standard.
- */
- Product?: NonEmptyString;
- }
- export type StandardsStatus = "PENDING"|"READY"|"FAILED"|"DELETING"|"INCOMPLETE"|string;
- export interface StandardsStatusReason {
- /**
- * The reason code that represents the reason for the current status of a standard subscription.
- */
- StatusReasonCode: StatusReasonCode;
- }
- export interface StandardsSubscription {
- /**
- * The ARN of a resource that represents your subscription to a supported standard.
- */
- StandardsSubscriptionArn: NonEmptyString;
- /**
- * The ARN of a standard.
- */
- StandardsArn: NonEmptyString;
- /**
- * A key-value pair of input for the standard.
- */
- StandardsInput: StandardsInputParameterMap;
- /**
- * The status of the standard subscription. The status values are as follows: PENDING - Standard is in the process of being enabled. READY - Standard is enabled. INCOMPLETE - Standard could not be enabled completely. Some controls may not be available. DELETING - Standard is in the process of being disabled. FAILED - Standard could not be disabled.
- */
- StandardsStatus: StandardsStatus;
- /**
- * The reason for the current status.
- */
- StandardsStatusReason?: StandardsStatusReason;
- }
- export type StandardsSubscriptionArns = NonEmptyString[];
- export interface StandardsSubscriptionRequest {
- /**
- * The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the DescribeStandards operation.
- */
- StandardsArn: NonEmptyString;
- /**
- * A key-value pair of input for the standard.
- */
- StandardsInput?: StandardsInputParameterMap;
- }
- export type StandardsSubscriptionRequests = StandardsSubscriptionRequest[];
- export type StandardsSubscriptions = StandardsSubscription[];
- export interface StartConfigurationPolicyAssociationRequest {
- /**
- * The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration.
- */
- ConfigurationPolicyIdentifier: NonEmptyString;
- /**
- * The identifier of the target account, organizational unit, or the root to associate with the specified configuration.
- */
- Target: Target;
- }
- export interface StartConfigurationPolicyAssociationResponse {
- /**
- * The UUID of the configuration policy.
- */
- ConfigurationPolicyId?: NonEmptyString;
- /**
- * The identifier of the target account, organizational unit, or the organization root with which the configuration is associated.
- */
- TargetId?: NonEmptyString;
- /**
- * Indicates whether the target is an Amazon Web Services account, organizational unit, or the organization root.
- */
- TargetType?: TargetType;
- /**
- * Indicates whether the association between the specified target and the configuration was directly applied by the Security Hub delegated administrator or inherited from a parent.
- */
- AssociationType?: AssociationType;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The current status of the association between the specified target and the configuration.
- */
- AssociationStatus?: ConfigurationPolicyAssociationStatus;
- /**
- * An explanation for a FAILED value for AssociationStatus.
- */
- AssociationStatusMessage?: NonEmptyString;
- }
- export interface StartConfigurationPolicyDisassociationRequest {
- /**
- * The identifier of the target account, organizational unit, or the root to disassociate from the specified configuration.
- */
- Target?: Target;
- /**
- * The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of SELF_MANAGED_SECURITY_HUB for a self-managed configuration.
- */
- ConfigurationPolicyIdentifier: NonEmptyString;
- }
- export interface StartConfigurationPolicyDisassociationResponse {
- }
- export interface StatelessCustomActionDefinition {
- /**
- * Information about metrics to publish to CloudWatch.
- */
- PublishMetricAction?: StatelessCustomPublishMetricAction;
- }
- export interface StatelessCustomPublishMetricAction {
- /**
- * Defines CloudWatch dimension values to publish.
- */
- Dimensions?: StatelessCustomPublishMetricActionDimensionsList;
- }
- export interface StatelessCustomPublishMetricActionDimension {
- /**
- * The value to use for the custom metric dimension.
- */
- Value?: NonEmptyString;
- }
- export type StatelessCustomPublishMetricActionDimensionsList = StatelessCustomPublishMetricActionDimension[];
- export interface StatusReason {
- /**
- * A code that represents a reason for the control status. For the list of status reason codes and their meanings, see Standards-related information in the ASFF in the Security Hub User Guide.
- */
- ReasonCode: NonEmptyString;
- /**
- * The corresponding description for the status reason code.
- */
- Description?: NonEmptyString;
- }
- export type StatusReasonCode = "NO_AVAILABLE_CONFIGURATION_RECORDER"|"INTERNAL_ERROR"|string;
- export type StatusReasonsList = StatusReason[];
- export interface StringConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is a string.
- */
- DefaultValue?: NonEmptyString;
- /**
- * An RE2 regular expression that Security Hub uses to validate a user-provided control parameter string.
- */
- Re2Expression?: NonEmptyString;
- /**
- * The description of the RE2 regular expression.
- */
- ExpressionDescription?: NonEmptyString;
- }
- export interface StringFilter {
- /**
- * The string filter value. Filter values are case sensitive. For example, the product name for control-based findings is Security Hub. If you provide security hub as the filter value, there's no match.
- */
- Value?: NonEmptyString;
- /**
- * The condition to apply to a string value when filtering Security Hub findings. To search for values that have the filter value, use one of the following comparison operators: To search for values that include the filter value, use CONTAINS. For example, the filter Title CONTAINS CloudFront matches findings that have a Title that includes the string CloudFront. To search for values that exactly match the filter value, use EQUALS. For example, the filter AwsAccountId EQUALS 123456789012 only matches findings that have an account ID of 123456789012. To search for values that start with the filter value, use PREFIX. For example, the filter ResourceRegion PREFIX us matches findings that have a ResourceRegion that starts with us. A ResourceRegion that starts with a different value, such as af, ap, or ca, doesn't match. CONTAINS, EQUALS, and PREFIX filters on the same field are joined by OR. A finding matches if it matches any one of those filters. For example, the filters Title CONTAINS CloudFront OR Title CONTAINS CloudWatch match a finding that includes either CloudFront, CloudWatch, or both strings in the title. To search for values that don’t have the filter value, use one of the following comparison operators: To search for values that exclude the filter value, use NOT_CONTAINS. For example, the filter Title NOT_CONTAINS CloudFront matches findings that have a Title that excludes the string CloudFront. To search for values other than the filter value, use NOT_EQUALS. For example, the filter AwsAccountId NOT_EQUALS 123456789012 only matches findings that have an account ID other than 123456789012. To search for values that don't start with the filter value, use PREFIX_NOT_EQUALS. For example, the filter ResourceRegion PREFIX_NOT_EQUALS us matches findings with a ResourceRegion that starts with a value other than us. NOT_CONTAINS, NOT_EQUALS, and PREFIX_NOT_EQUALS filters on the same field are joined by AND. A finding matches only if it matches all of those filters. For example, the filters Title NOT_CONTAINS CloudFront AND Title NOT_CONTAINS CloudWatch match a finding that excludes both CloudFront and CloudWatch in the title. You can’t have both a CONTAINS filter and a NOT_CONTAINS filter on the same field. Similarly, you can't provide both an EQUALS filter and a NOT_EQUALS or PREFIX_NOT_EQUALS filter on the same field. Combining filters in this way returns an error. CONTAINS filters can only be used with other CONTAINS filters. NOT_CONTAINS filters can only be used with other NOT_CONTAINS filters. You can combine PREFIX filters with NOT_EQUALS or PREFIX_NOT_EQUALS filters for the same field. Security Hub first processes the PREFIX filters, and then the NOT_EQUALS or PREFIX_NOT_EQUALS filters. For example, for the following filters, Security Hub first identifies findings that have resource types that start with either AwsIam or AwsEc2. It then excludes findings that have a resource type of AwsIamPolicy and findings that have a resource type of AwsEc2NetworkInterface. ResourceType PREFIX AwsIam ResourceType PREFIX AwsEc2 ResourceType NOT_EQUALS AwsIamPolicy ResourceType NOT_EQUALS AwsEc2NetworkInterface CONTAINS and NOT_CONTAINS operators can be used only with automation rules. For more information, see Automation rules in the Security Hub User Guide.
- */
- Comparison?: StringFilterComparison;
- }
- export type StringFilterComparison = "EQUALS"|"PREFIX"|"NOT_EQUALS"|"PREFIX_NOT_EQUALS"|"CONTAINS"|"NOT_CONTAINS"|string;
- export type StringFilterList = StringFilter[];
- export type StringList = NonEmptyString[];
- export interface StringListConfigurationOptions {
- /**
- * The Security Hub default value for a control parameter that is a list of strings.
- */
- DefaultValue?: StringList;
- /**
- * An RE2 regular expression that Security Hub uses to validate a user-provided list of strings for a control parameter.
- */
- Re2Expression?: NonEmptyString;
- /**
- * The maximum number of list items that a string list control parameter can accept.
- */
- MaxItems?: Integer;
- /**
- * The description of the RE2 regular expression.
- */
- ExpressionDescription?: NonEmptyString;
- }
- export type TagKey = string;
- export type TagKeyList = TagKey[];
- export type TagMap = {[key: string]: TagValue};
- export interface TagResourceRequest {
- /**
- * The ARN of the resource to apply the tags to.
- */
- ResourceArn: ResourceArn;
- /**
- * The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.
- */
- Tags: TagMap;
- }
- export interface TagResourceResponse {
- }
- export type TagValue = string;
- export interface Target {
- /**
- * The Amazon Web Services account ID of the target account.
- */
- AccountId?: NonEmptyString;
- /**
- * The organizational unit ID of the target organizational unit.
- */
- OrganizationalUnitId?: NonEmptyString;
- /**
- * The ID of the organization root.
- */
- RootId?: NonEmptyString;
- }
- export type TargetType = "ACCOUNT"|"ORGANIZATIONAL_UNIT"|string;
- export interface Threat {
- /**
- * The name of the threat.
- */
- Name?: NonEmptyString;
- /**
- * The severity of the threat.
- */
- Severity?: NonEmptyString;
- /**
- * This total number of items in which the threat has been detected.
- */
- ItemCount?: Integer;
- /**
- * Provides information about the file paths that were affected by the threat.
- */
- FilePaths?: FilePathList;
- }
- export interface ThreatIntelIndicator {
- /**
- * The type of threat intelligence indicator.
- */
- Type?: ThreatIntelIndicatorType;
- /**
- * The value of a threat intelligence indicator.
- */
- Value?: NonEmptyString;
- /**
- * The category of a threat intelligence indicator.
- */
- Category?: ThreatIntelIndicatorCategory;
- /**
- * Indicates when the most recent instance of a threat intelligence indicator was observed. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- LastObservedAt?: NonEmptyString;
- /**
- * The source of the threat intelligence indicator.
- */
- Source?: NonEmptyString;
- /**
- * The URL to the page or site where you can get more information about the threat intelligence indicator.
- */
- SourceUrl?: NonEmptyString;
- }
- export type ThreatIntelIndicatorCategory = "BACKDOOR"|"CARD_STEALER"|"COMMAND_AND_CONTROL"|"DROP_SITE"|"EXPLOIT_SITE"|"KEYLOGGER"|string;
- export type ThreatIntelIndicatorList = ThreatIntelIndicator[];
- export type ThreatIntelIndicatorType = "DOMAIN"|"EMAIL_ADDRESS"|"HASH_MD5"|"HASH_SHA1"|"HASH_SHA256"|"HASH_SHA512"|"IPV4_ADDRESS"|"IPV6_ADDRESS"|"MUTEX"|"PROCESS"|"URL"|string;
- export type ThreatList = Threat[];
- export type Timestamp = Date;
- export type TypeList = NonEmptyString[];
- export interface UnprocessedAutomationRule {
- /**
- * The Amazon Resource Name (ARN) for the unprocessed automation rule.
- */
- RuleArn?: NonEmptyString;
- /**
- * The error code associated with the unprocessed automation rule.
- */
- ErrorCode?: Integer;
- /**
- * An error message describing why a request didn't process a specific rule.
- */
- ErrorMessage?: NonEmptyString;
- }
- export type UnprocessedAutomationRulesList = UnprocessedAutomationRule[];
- export interface UnprocessedConfigurationPolicyAssociation {
- /**
- * Configuration policy association identifiers that were specified in a BatchGetConfigurationPolicyAssociations request but couldn’t be processed due to an error.
- */
- ConfigurationPolicyAssociationIdentifiers?: ConfigurationPolicyAssociation;
- /**
- * An HTTP status code that identifies why the configuration policy association failed.
- */
- ErrorCode?: NonEmptyString;
- /**
- * A string that identifies why the configuration policy association failed.
- */
- ErrorReason?: NonEmptyString;
- }
- export type UnprocessedConfigurationPolicyAssociationList = UnprocessedConfigurationPolicyAssociation[];
- export type UnprocessedErrorCode = "INVALID_INPUT"|"ACCESS_DENIED"|"NOT_FOUND"|"LIMIT_EXCEEDED"|string;
- export interface UnprocessedSecurityControl {
- /**
- * The control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) for which a response couldn't be returned.
- */
- SecurityControlId: NonEmptyString;
- /**
- * The error code for the unprocessed security control.
- */
- ErrorCode: UnprocessedErrorCode;
- /**
- * The reason why the security control was unprocessed.
- */
- ErrorReason?: NonEmptyString;
- }
- export type UnprocessedSecurityControls = UnprocessedSecurityControl[];
- export interface UnprocessedStandardsControlAssociation {
- /**
- * An array with one or more objects that includes a security control (identified with SecurityControlId, SecurityControlArn, or a mix of both parameters) and the Amazon Resource Name (ARN) of a standard. This parameter shows the specific controls for which the enablement status couldn't be retrieved in specified standards when calling BatchUpdateStandardsControlAssociations.
- */
- StandardsControlAssociationId: StandardsControlAssociationId;
- /**
- * The error code for the unprocessed standard and control association.
- */
- ErrorCode: UnprocessedErrorCode;
- /**
- * The reason why the standard and control association was unprocessed.
- */
- ErrorReason?: NonEmptyString;
- }
- export interface UnprocessedStandardsControlAssociationUpdate {
- /**
- * An array of control and standard associations for which an update failed when calling BatchUpdateStandardsControlAssociations.
- */
- StandardsControlAssociationUpdate: StandardsControlAssociationUpdate;
- /**
- * The error code for the unprocessed update of the control's enablement status in the specified standard.
- */
- ErrorCode: UnprocessedErrorCode;
- /**
- * The reason why a control's enablement status in the specified standard couldn't be updated.
- */
- ErrorReason?: NonEmptyString;
- }
- export type UnprocessedStandardsControlAssociationUpdates = UnprocessedStandardsControlAssociationUpdate[];
- export type UnprocessedStandardsControlAssociations = UnprocessedStandardsControlAssociation[];
- export interface UntagResourceRequest {
- /**
- * The ARN of the resource to remove the tags from.
- */
- ResourceArn: ResourceArn;
- /**
- * The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.
- */
- TagKeys: TagKeyList;
- }
- export interface UntagResourceResponse {
- }
- export interface UpdateActionTargetRequest {
- /**
- * The ARN of the custom action target to update.
- */
- ActionTargetArn: NonEmptyString;
- /**
- * The updated name of the custom action target.
- */
- Name?: NonEmptyString;
- /**
- * The updated description for the custom action target.
- */
- Description?: NonEmptyString;
- }
- export interface UpdateActionTargetResponse {
- }
- export interface UpdateAutomationRulesRequestItem {
- /**
- * The Amazon Resource Name (ARN) for the rule.
- */
- RuleArn: NonEmptyString;
- /**
- * Whether the rule is active after it is created. If this parameter is equal to ENABLED, Security Hub starts applying the rule to findings and finding updates after the rule is created. To change the value of this parameter after creating a rule, use BatchUpdateAutomationRules .
- */
- RuleStatus?: RuleStatus;
- /**
- * An integer ranging from 1 to 1000 that represents the order in which the rule action is applied to findings. Security Hub applies rules with lower values for this parameter first.
- */
- RuleOrder?: RuleOrderValue;
- /**
- * A description of the rule.
- */
- Description?: NonEmptyString;
- /**
- * The name of the rule.
- */
- RuleName?: NonEmptyString;
- /**
- * Specifies whether a rule is the last to be applied with respect to a finding that matches the rule criteria. This is useful when a finding matches the criteria for multiple rules, and each rule has different actions. If a rule is terminal, Security Hub applies the rule action to a finding that matches the rule criteria and doesn't evaluate other rules for the finding. By default, a rule isn't terminal.
- */
- IsTerminal?: Boolean;
- /**
- * A set of ASFF finding field attributes and corresponding expected values that Security Hub uses to filter findings. If a rule is enabled and a finding matches the conditions specified in this parameter, Security Hub applies the rule action to the finding.
- */
- Criteria?: AutomationRulesFindingFilters;
- /**
- * One or more actions to update finding fields if a finding matches the conditions specified in Criteria.
- */
- Actions?: ActionList;
- }
- export type UpdateAutomationRulesRequestItemsList = UpdateAutomationRulesRequestItem[];
- export interface UpdateConfigurationPolicyRequest {
- /**
- * The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
- */
- Identifier: NonEmptyString;
- /**
- * The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted: -, ., !, *, /.
- */
- Name?: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * The reason for updating the configuration policy.
- */
- UpdatedReason?: NonEmptyString;
- /**
- * An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls). When updating a configuration policy, provide a complete list of standards that you want to enable and a complete list of controls that you want to enable or disable. The updated configuration replaces the current configuration.
- */
- ConfigurationPolicy?: Policy;
- }
- export interface UpdateConfigurationPolicyResponse {
- /**
- * The ARN of the configuration policy.
- */
- Arn?: NonEmptyString;
- /**
- * The UUID of the configuration policy.
- */
- Id?: NonEmptyString;
- /**
- * The name of the configuration policy.
- */
- Name?: NonEmptyString;
- /**
- * The description of the configuration policy.
- */
- Description?: NonEmptyString;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
- */
- UpdatedAt?: Timestamp;
- /**
- * The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
- */
- CreatedAt?: Timestamp;
- /**
- * An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly released controls). If the request included a list of security controls that are disabled in the configuration policy, Security Hub enables all other controls (including newly released controls).
- */
- ConfigurationPolicy?: Policy;
- }
- export interface UpdateFindingAggregatorRequest {
- /**
- * The ARN of the finding aggregator. To obtain the ARN, use ListFindingAggregators.
- */
- FindingAggregatorArn: NonEmptyString;
- /**
- * Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them. The selected option also determines how to use the Regions provided in the Regions list. The options are as follows: ALL_REGIONS - Indicates to aggregate findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. ALL_REGIONS_EXCEPT_SPECIFIED - Indicates to aggregate findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the Regions parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them. SPECIFIED_REGIONS - Indicates to aggregate findings only from the Regions listed in the Regions parameter. Security Hub does not automatically aggregate findings from new Regions.
- */
- RegionLinkingMode: NonEmptyString;
- /**
- * If RegionLinkingMode is ALL_REGIONS_EXCEPT_SPECIFIED, then this is a space-separated list of Regions that do not aggregate findings to the aggregation Region. If RegionLinkingMode is SPECIFIED_REGIONS, then this is a space-separated list of Regions that do aggregate findings to the aggregation Region.
- */
- Regions?: StringList;
- }
- export interface UpdateFindingAggregatorResponse {
- /**
- * The ARN of the finding aggregator.
- */
- FindingAggregatorArn?: NonEmptyString;
- /**
- * The aggregation Region.
- */
- FindingAggregationRegion?: NonEmptyString;
- /**
- * Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.
- */
- RegionLinkingMode?: NonEmptyString;
- /**
- * The list of excluded Regions or included Regions.
- */
- Regions?: StringList;
- }
- export interface UpdateFindingsRequest {
- /**
- * A collection of attributes that specify which findings you want to update.
- */
- Filters: AwsSecurityFindingFilters;
- /**
- * The updated note for the finding.
- */
- Note?: NoteUpdate;
- /**
- * The updated record state for the finding.
- */
- RecordState?: RecordState;
- }
- export interface UpdateFindingsResponse {
- }
- export interface UpdateInsightRequest {
- /**
- * The ARN of the insight that you want to update.
- */
- InsightArn: NonEmptyString;
- /**
- * The updated name for the insight.
- */
- Name?: NonEmptyString;
- /**
- * The updated filters that define this insight.
- */
- Filters?: AwsSecurityFindingFilters;
- /**
- * The updated GroupBy attribute that defines this insight.
- */
- GroupByAttribute?: NonEmptyString;
- }
- export interface UpdateInsightResponse {
- }
- export interface UpdateOrganizationConfigurationRequest {
- /**
- * Whether to automatically enable Security Hub in new member accounts when they join the organization. If set to true, then Security Hub is automatically enabled in new accounts. If set to false, then Security Hub isn't enabled in new accounts automatically. The default value is false. If the ConfigurationType of your organization is set to CENTRAL, then this field is set to false and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which Security Hub is enabled and associate the policy with new organization accounts.
- */
- AutoEnable: Boolean;
- /**
- * Whether to automatically enable Security Hub default standards in new member accounts when they join the organization. The default value of this parameter is equal to DEFAULT. If equal to DEFAULT, then Security Hub default standards are automatically enabled for new member accounts. If equal to NONE, then default standards are not automatically enabled for new member accounts. If the ConfigurationType of your organization is set to CENTRAL, then this field is set to NONE and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration policy in which specific security standards are enabled and associate the policy with new organization accounts.
- */
- AutoEnableStandards?: AutoEnableStandards;
- OrganizationConfiguration?: OrganizationConfiguration;
- }
- export interface UpdateOrganizationConfigurationResponse {
- }
- export interface UpdateSecurityControlRequest {
- /**
- * The Amazon Resource Name (ARN) or ID of the control to update.
- */
- SecurityControlId: NonEmptyString;
- /**
- * An object that specifies which security control parameters to update.
- */
- Parameters: Parameters;
- /**
- * The most recent reason for updating the properties of the security control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.
- */
- LastUpdateReason?: AlphaNumericNonEmptyString;
- }
- export interface UpdateSecurityControlResponse {
- }
- export interface UpdateSecurityHubConfigurationRequest {
- /**
- * Whether to automatically enable new controls when they are added to standards that are enabled. By default, this is set to true, and new controls are enabled automatically. To not automatically enable new controls, set this to false.
- */
- AutoEnableControls?: Boolean;
- /**
- * Updates whether the calling account has consolidated control findings turned on. If the value for this field is set to SECURITY_CONTROL, Security Hub generates a single finding for a control check even when the check applies to multiple enabled standards. If the value for this field is set to STANDARD_CONTROL, Security Hub generates separate findings for a control check when the check applies to multiple enabled standards. For accounts that are part of an organization, this value can only be updated in the administrator account.
- */
- ControlFindingGenerator?: ControlFindingGenerator;
- }
- export interface UpdateSecurityHubConfigurationResponse {
- }
- export interface UpdateStandardsControlRequest {
- /**
- * The ARN of the security standard control to enable or disable.
- */
- StandardsControlArn: NonEmptyString;
- /**
- * The updated status of the security standard control.
- */
- ControlStatus?: ControlStatus;
- /**
- * A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.
- */
- DisabledReason?: NonEmptyString;
- }
- export interface UpdateStandardsControlResponse {
- }
- export type UpdateStatus = "READY"|"UPDATING"|string;
- export type VerificationState = "UNKNOWN"|"TRUE_POSITIVE"|"FALSE_POSITIVE"|"BENIGN_POSITIVE"|string;
- export interface VolumeMount {
- /**
- * The name of the volume.
- */
- Name?: NonEmptyString;
- /**
- * The path in the container at which the volume should be mounted.
- */
- MountPath?: NonEmptyString;
- }
- export type VolumeMountList = VolumeMount[];
- export interface VpcInfoCidrBlockSetDetails {
- /**
- * The IPv4 CIDR block for the VPC.
- */
- CidrBlock?: NonEmptyString;
- }
- export type VpcInfoCidrBlockSetList = VpcInfoCidrBlockSetDetails[];
- export interface VpcInfoIpv6CidrBlockSetDetails {
- /**
- * The IPv6 CIDR block for the VPC.
- */
- Ipv6CidrBlock?: NonEmptyString;
- }
- export type VpcInfoIpv6CidrBlockSetList = VpcInfoIpv6CidrBlockSetDetails[];
- export interface VpcInfoPeeringOptionsDetails {
- /**
- * Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.
- */
- AllowDnsResolutionFromRemoteVpc?: Boolean;
- /**
- * Indicates whether a local ClassicLink connection can communicate with the peer VPC over the VPC peering connection.
- */
- AllowEgressFromLocalClassicLinkToRemoteVpc?: Boolean;
- /**
- * Indicates whether a local VPC can communicate with a ClassicLink connection in the peer VPC over the VPC peering connection.
- */
- AllowEgressFromLocalVpcToRemoteClassicLink?: Boolean;
- }
- export interface Vulnerability {
- /**
- * The identifier of the vulnerability.
- */
- Id: NonEmptyString;
- /**
- * List of software packages that have the vulnerability.
- */
- VulnerablePackages?: SoftwarePackageList;
- /**
- * CVSS scores from the advisory related to the vulnerability.
- */
- Cvss?: CvssList;
- /**
- * List of vulnerabilities that are related to this vulnerability.
- */
- RelatedVulnerabilities?: StringList;
- /**
- * Information about the vendor that generates the vulnerability report.
- */
- Vendor?: VulnerabilityVendor;
- /**
- * A list of URLs that provide additional information about the vulnerability.
- */
- ReferenceUrls?: StringList;
- /**
- * Specifies if all vulnerable packages in a finding have a value for FixedInVersion and Remediation. This field is evaluated for each vulnerability Id based on the number of vulnerable packages that have a value for both FixedInVersion and Remediation. Valid values are as follows: YES if all vulnerable packages have a value for both FixedInVersion and Remediation NO if no vulnerable packages have a value for FixedInVersion and Remediation PARTIAL otherwise
- */
- FixAvailable?: VulnerabilityFixAvailable;
- /**
- * The Exploit Prediction Scoring System (EPSS) score for a finding.
- */
- EpssScore?: Double;
- /**
- * Whether an exploit is available for a finding.
- */
- ExploitAvailable?: VulnerabilityExploitAvailable;
- /**
- * The date and time of the last exploit associated with a finding discovered in your environment.
- */
- LastKnownExploitAt?: NonEmptyString;
- /**
- * The vulnerabilities found in your Lambda function code. This field pertains to findings that Security Hub receives from Amazon Inspector.
- */
- CodeVulnerabilities?: VulnerabilityCodeVulnerabilitiesList;
- }
- export interface VulnerabilityCodeVulnerabilities {
- /**
- * The Common Weakness Enumeration (CWE) item associated with the detected code vulnerability.
- */
- Cwes?: TypeList;
- /**
- * Provides details about where a code vulnerability is located in your Lambda function.
- */
- FilePath?: CodeVulnerabilitiesFilePath;
- /**
- * The Amazon Resource Name (ARN) of the Lambda layer in which the code vulnerability is located.
- */
- SourceArn?: NonEmptyString;
- }
- export type VulnerabilityCodeVulnerabilitiesList = VulnerabilityCodeVulnerabilities[];
- export type VulnerabilityExploitAvailable = "YES"|"NO"|string;
- export type VulnerabilityFixAvailable = "YES"|"NO"|"PARTIAL"|string;
- export type VulnerabilityList = Vulnerability[];
- export interface VulnerabilityVendor {
- /**
- * The name of the vendor.
- */
- Name: NonEmptyString;
- /**
- * The URL of the vulnerability advisory.
- */
- Url?: NonEmptyString;
- /**
- * The severity that the vendor assigned to the vulnerability.
- */
- VendorSeverity?: NonEmptyString;
- /**
- * Indicates when the vulnerability advisory was created. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- VendorCreatedAt?: NonEmptyString;
- /**
- * Indicates when the vulnerability advisory was last updated. This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples: YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z) YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z) YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59) YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759) YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
- */
- VendorUpdatedAt?: NonEmptyString;
- }
- export interface WafAction {
- /**
- * Specifies how you want WAF to respond to requests that match the settings in a rule. Valid settings include the following: ALLOW - WAF allows requests BLOCK - WAF blocks requests COUNT - WAF increments a counter of the requests that match all of the conditions in the rule. WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a web ACL.
- */
- Type?: NonEmptyString;
- }
- export interface WafExcludedRule {
- /**
- * The unique identifier for the rule to exclude from the rule group.
- */
- RuleId?: NonEmptyString;
- }
- export type WafExcludedRuleList = WafExcludedRule[];
- export interface WafOverrideAction {
- /**
- * COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action takes place.
- */
- Type?: NonEmptyString;
- }
- export interface Workflow {
- /**
- * The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue. The allowed values are the following. NEW - The initial state of a finding, before it is reviewed. Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases: RecordState changes from ARCHIVED to ACTIVE. ComplianceStatus changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE. NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated. RESOLVED - The finding was reviewed and remediated and is now considered resolved.
- */
- Status?: WorkflowStatus;
- }
- export type WorkflowState = "NEW"|"ASSIGNED"|"IN_PROGRESS"|"DEFERRED"|"RESOLVED"|string;
- export type WorkflowStatus = "NEW"|"NOTIFIED"|"RESOLVED"|"SUPPRESSED"|string;
- export interface WorkflowUpdate {
- /**
- * The status of the investigation into the finding. The workflow status is specific to an individual finding. It does not affect the generation of new findings. For example, setting the workflow status to SUPPRESSED or RESOLVED does not prevent a new finding for the same issue. The allowed values are the following. NEW - The initial state of a finding, before it is reviewed. Security Hub also resets WorkFlowStatus from NOTIFIED or RESOLVED to NEW in the following cases: The record state changes from ARCHIVED to ACTIVE. The compliance status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE. NOTIFIED - Indicates that you notified the resource owner about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner. RESOLVED - The finding was reviewed and remediated and is now considered resolved. SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is needed. The finding is no longer updated.
- */
- Status?: WorkflowStatus;
- }
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2018-10-26"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the SecurityHub client.
- */
- export import Types = SecurityHub;
- }
- export = SecurityHub;
|