Skip to main content

Developer Portal

Home
APIs/Events
- API Search
- Event Search
- API Search
- Event Search
Documentation
Community & News

Fargate API Template

Latest GitHub Release

GitHub Issues

GitHub Pulls

https://github.com/byu-oit/hw-fargate-api/

Example of creating and deploying a containerized API to AWS. Terraform is used to create infrastructure. Docker on Fargate is used for the runtime environment. CodeDeploy is used for Blue/Green deployments, with Lambda and Postman for deployment tests.

Contact

Text: (801) 422-4000
Email: it@byu.edu
Call: (801) 422-4711

Resources

BYU Home

Brand Guide

Web Community

Licensing and Trademarks

Policies

General Privacy Policy

Minimum Security Controls

{transparentHeader=false, language=en, main=[{_template=/core/text/RichTextModule.hbs, _styledTemplate=/core/text/RichText--FullWidth.hbs, anchor=richtext-https-github, items=[{items=[ <p> </p>]}, {_template=/core/enhancement/Enhancement.hbs, item=[{_template=/core/module/ModuleType.hbs, content=[{_template=/raw-html/RawHtmlModule.hbs, anchor=rawhtml-00000182-c6ca-d, html=<a href="https://github.com/byu-oit/hw-fargate-api/releases/"><img src="https://img.shields.io/github/v/release/byu-oit/hw-fargate-api?sort=semver" alt="Latest GitHub Release"></a> <a href="https://github.com/byu-oit/hw-fargate-api/actions?query=workflow%3ACI"><img src="https://github.com/byu-oit/hw-fargate-api/workflows/CI/badge.svg" alt="CI"></a> <a href="https://github.com/byu-oit/hw-fargate-api/actions?query=workflow%3A%22CI%2FCD+Pipeline%22"><img src="https://github.com/byu-oit/hw-fargate-api/workflows/CI/CD%20Pipeline/badge.svg" alt="CI/CD Pipeline"></a> <a href="https://github.com/byu-oit/hw-fargate-api/issues/"><img src="https://img.shields.io/github/issues/byu-oit/hw-fargate-api.svg" alt="GitHub Issues"></a> <a href="https://github.com/byu-oit/hw-fargate-api/pulls/"><img src="https://img.shields.io/github/issues-pr/byu-oit/hw-fargate-api.svg" alt="GitHub Pulls"></a>, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], inline=false, enableEnhancementOverlay=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {items=[<p> <br>]}, {_template=/core/enhancement/Enhancement.hbs, item=[{_template=/core/link/Link.hbs, href=https://github.com/byu-oit/hw-fargate-api/, target=_blank, body=https://github.com/byu-oit/hw-fargate-api/, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], inline=true, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {items=[ </p> <p>Example of creating and deploying a containerized API to AWS. Terraform is used to create infrastructure. Docker on Fargate is used for the runtime environment. CodeDeploy is used for Blue/Green deployments, with Lambda and Postman for deployment tests. </p> ]}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], asideRemoveOffset=false, canonicalLink=https://developer.byu.edu/fargate-api-template, hidePromoSection=false, extraBodyItems=[], navigation=[{_template=/core/navigation/Navigation.hbs, items=[{_template=/core/navigation/NavigationItem.hbs, isCurrent=false, items=[], href=https://developer.byu.edu/, text=Home, contentId=00000180-e344-d2d1-ade4-e374b5f00000, displayInRightNavigation=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationItem.hbs, isCurrent=false, items=[{_template=/core/navigation/NavigationLink.hbs, href=https://developer.byu.edu/api-search, text=API Search, contentId=00000181-62e1-d0ac-abe9-eef73e250000, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationLink.hbs, href=https://developer.byu.edu/event-search, text=Event Search, contentId=00000181-62e1-d0f9-a7bd-ffe3e5ee0000, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], text=APIs/Events, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationItem.hbs, isCurrent=false, items=[], href=https://developer.byu.edu/documentation, text=Documentation, contentId=00000181-62e3-d9e0-a789-7ef7ed650000, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationItem.hbs, isCurrent=false, items=[], href=https://developer.byu.edu/community-news, text=Community & News, contentId=00000181-62e7-d9e0-a789-7ef7d95d0000, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], pageHeading=Fargate API Template, above=[], favicons=[{_template=/core/page/Favicon.hbs, href=/apple-touch-icon.png, rel=apple-touch-icon, sizes=180x180}, {_template=/core/page/Favicon.hbs, href=/favicon-32x32.png, rel=icon, type=image/png}, {_template=/core/page/Favicon.hbs, href=/favicon-16x16.png, rel=icon, type=image/png}], logo=[{_template=/core/page/PageLogo.hbs, href=https://byu.edu, target=_blank, alt=BYU, image={src=https://brightspotcdn.byu.edu/e4/0a/b679ee0a41d9b1675fc78cd03239/byu-logo-white-small.svg, width=90, height=28}, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], openSectionMenuText=Open section menu, hat=[], footerNavigation=[{_template=/core/navigation/Navigation.hbs, items=[{_template=/core/navigation/NavigationItem.hbs, items=[{_template=/core/navigation/NavigationLink.hbs, href=https://byu.edu, target=_blank, text=BYU Home, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationLink.hbs, href=https://brand.byu.edu/, target=_blank, text=Brand Guide, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationLink.hbs, href=https://webcommunity.byu.edu/, target=_blank, text=Web Community, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationLink.hbs, href=https://licensing.byu.edu/, target=_blank, text=Licensing and Trademarks, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], text=Resources, isCurrent=false, displayInRightNavigation=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationItem.hbs, items=[{_template=/core/navigation/NavigationLink.hbs, href=https://infosec.byu.edu/privacy, target=_blank, text=General Privacy Policy, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/navigation/NavigationLink.hbs, href=https://infosec.byu.edu/minimum-security-controls-for-it-resources, target=_blank, text=Minimum Security Controls, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], text=Policies, isCurrent=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], headerCustomButton=[], below=[], _parentFiles=[/core/page/Page-footer.hbs], hideReadTime=true, headerTitleLogo=[], headerLinks=[], extraScripts=[{_template=/core/page/InlineScript.hbs, script=window["adrum-start-time"] = new Date().getTime(); (function(config){ config.appKey = "AD-AAB-ABM-KFS"; config.adrumExtUrlHttp = "http://cdn.appdynamics.com"; config.adrumExtUrlHttps = "https://cdn.appdynamics.com"; config.beaconUrlHttp = "http://pdx-col.eum-appdynamics.com"; config.beaconUrlHttps = "https://pdx-col.eum-appdynamics.com"; config.resTiming = {"bufSize":200,"clearResTimingOnBeaconSend":true}; config.maxUrlLength = 512; })(window["adrum-config"] || (window["adrum-config"] = {}));, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/page/ExternalScript.hbs, src=https://cdn.appdynamics.com/adrum/adrum-latest.js, async=true, defer=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/page/InlineScript.hbs, script=/*** BYU Meru Data Cookie Consent Banner and Cookie AutoBlocking ***/ const merudata_scripts = (function() { const byu_merudataID = "c5d6912a-d8fc-4138-8d1d-6daeb3056f57"; const byuh_merudataID = "3ef2e724-39fd-43dd-bcf0-9a418af50116"; const merudata_url = "https://ccm.merudata.app/assets/"; let domain_merudataID = null; // Set in isBYU() or isHawaii() // If this is a production BYU or BYU-Hawaii site, load the scripts if ( !isPreview() ) { if ( isBYU() || isHawaii() ) { loadConfig(); } } // Preview site? function isPreview() { return window.location.hostname.includes( "brigham-young.psdops.com" ); } // BYU site? function isBYU() { let isBYU = window.location.hostname.includes( "byu.edu" ); if ( isBYU ) { domain_merudataID = byu_merudataID; } return isBYU; } // BYU-Hawaii site? function isHawaii() { const isByuH_url = window.location.hostname.includes( "byuh.edu" ); const styleEl = document.querySelectorAll("style[data-cssvarsponyfill='true']")[0]; let isBYUH = isByuH_url || (styleEl ? styleEl.textContent.includes("--primaryColor: #9e1b34;") : false); if ( isBYUH ) { domain_merudataID = byuh_merudataID; } return isBYUH; } // Load scripts function loadConfig() { let scriptConfig = document.createElement("script"); scriptConfig.src = merudata_url + domain_merudataID + "/ccmconfig.js"; scriptConfig.onload = function() { loadScript(); // Load the script file loadStylesheet(); // Load the stylesheet file }; document.head.appendChild(scriptConfig); } function loadScript() { let script = document.createElement("script"); script.src = merudata_url + domain_merudataID + "/d_ccm.min.js"; document.head.appendChild(script); } function loadStylesheet() { let stylesheet = document.createElement("link"); stylesheet.rel = "stylesheet"; stylesheet.href = merudata_url + domain_merudataID + "/ccm.min.css" ; stylesheet.media = "print"; stylesheet.onload = function() { this.media = 'all'; }; document.head.appendChild(stylesheet); } })();, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], asideCanToggle=false, feedLink= <link type="application/rss+xml" rel="alternate" title="Fargate API Template" href="https://developer.byu.edu/fargate-api-template.rss"> , aside=[], meta=[{_template=/core/page/SeoRobotsMeta.hbs, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/facebook/OpenGraphMeta.hbs, title=Fargate API Template, url=https://developer.byu.edu/fargate-api-template, images=[{_template=/facebook/OpenGraphImageMeta.hbs, mimeType=image, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], determiner=, siteName=Developer, type=[{_template=/facebook/OpenGraphWebsiteMeta.hbs, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/twitter/card/TwitterSummaryLargeImageCard.hbs, title=Fargate API Template, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/facebook/FacebookMetas.hbs, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], actions=[], pageLead=[], headerTitle=[{_template=/core/link/Link.hbs, href=https://developer.byu.edu/, body= Developer Portal , contentId=00000180-e344-d2d1-ade4-e374b3d60005, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], footerContent=[{_template=/core/text/RichTextModule.hbs, _styledTemplate=/core/text/RichTextModule.hbs, anchor=richtext-need-help-contact-us, title=Contact, items=[{items=[<p>]}, {_template=/core/enhancement/Enhancement.hbs, item=[{_template=/core/link/Link.hbs, href=sms://+18014224000, target=_blank, body=Text: (801) 422-4000, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], inline=true, enableEnhancementOverlay=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {items=[ <br>]}, {_template=/core/enhancement/Enhancement.hbs, item=[{_template=/core/link/Link.hbs, href=mailto:it@byu.edu, target=_blank, body=Email: it@byu.edu, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], inline=true, enableEnhancementOverlay=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {items=[ <br>]}, {_template=/core/enhancement/Enhancement.hbs, item=[{_template=/core/link/Link.hbs, href=tel:18014224711, target=_blank, body=Call: (801) 422-4711, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], inline=true, enableEnhancementOverlay=false, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {items=[ </p> ]}], footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], _template=/core/page/Page-footer.hbs, contentId=00000182-c6ba-d415-a3b3-d6fa799a0000, headerDividerColor=#0057b8, title=Fargate API Template, footerLogo=[{_template=/core/page/PageLogo.hbs, alt=Brigham Young University, href=http://byu.edu, image={src=https://brightspotcdn.byu.edu/1d/91/168937d54d97829e751ccaa8f25f/byu-wordmark-ring.svg, width=null, height=null}, target=_blank, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], siteNavigationItemHoverColor=#fafafa, headerTitleBreadcrumbs=[], closeSectionMenuText=Close section menu, alignAsideToTheRight=false, disclaimer= ©2023 Brigham Young University , social=[], footerSecondaryLogo=[{_template=/core/page/PageLogo.hbs, alt=Brigham Young University, href=http://byu.edu, image={src=https://brightspotcdn.byu.edu/1d/91/168937d54d97829e751ccaa8f25f/byu-wordmark-ring.svg, width=null, height=null}, target=_blank, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], privacyPolicy= <span class="Enhancement display-inline"><a class="Link" href="http://www.byu.edu/privacy" target="_blank" >Privacy Notice<svg class="icon icon-external-link"><use xlink:href="#icon-external-link"/></svg></a></span> | <span class="Enhancement display-inline"><a class="Link" href="https://www.byu.edu/cookie-preferences" target="_blank" >Cookie Preferences<svg class="icon icon-external-link"><use xlink:href="#icon-external-link"/></svg></a></span> , bodyFont=Public Sans, banner=[], siteLeadBackgroundImage=[], extraBodyAttributes=[], footerBgColor=#f9f9f9, disclaimerContentSpacing=2.0, extraStyles=[{_template=/core/page/ExternalStyle.hbs, href=https://brightspot.byu.edu/override-styles.css, footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}, {_template=/core/page/InlineStyle.hbs, style= .Footer-logo { display: block !important; } .Footer-logo:nth-child(2) { display: none !important; } .Footer-logo:nth-of-type(2) { display: none !important; } , footerBgColor=#f9f9f9, headerDividerColor=#0057b8, siteNavigationItemHoverColor=#fafafa, bodyFont=Public Sans, disclaimerContentSpacing=2.0}], searchAction=https://developer.byu.edu/search, mobileDisclaimer= ©2023 Brigham Young University }

©2023 Brigham Young University

©2023 Brigham Young University

Privacy Notice | Cookie Preferences