/dhall-aws-cloudformation/gh-pages/sam/AWS::Serverless::Api/Properties.dhall.html

Copy path to clipboard

Source

<!DOCTYPE HTML><html><head><title>/sam/AWS::Serverless::Api/Properties.dhall</title><link rel="stylesheet" type="text/css" href="../../index.css"><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css2?family=Fira+Code:wght@400;500;600;700&amp;family=Lato:ital,wght@0,400;0,700;1,400&amp;display=swap"><script type="text/javascript" src="../../index.js"></script><meta charset="UTF-8"></head><body><div class="nav-bar"><img class="dhall-icon" src="../../dhall-icon.svg"><p class="package-title">dhall-aws-cloudformation</p><div class="nav-bar-content-divider"></div><a id="switch-light-dark-mode" class="nav-option">Switch Light/Dark Mode</a></div><div class="main-container"><h2 class="doc-title"><span class="crumb-divider">/</span><a href="../../index.html">dhall-aws-cloudformation</a><span class="crumb-divider">/</span><a class="title-crumb" href="../index.html">sam</a><span class="crumb-divider">/</span><a class="title-crumb" href="index.html">AWS::Serverless::Api</a><span class="crumb-divider">/</span><span class="title-crumb" href="index.html">Properties.dhall</span></h2><a class="copy-to-clipboard" data-path="https://raw.githubusercontent.com/jcouyang/dhall-aws-cloudformation/0.9.81/sam/AWS::Serverless::Api/Properties.dhall"><i><small>Copy path to clipboard</small></i></a><br><div class="doc-contents"></div><h3>Source</h3><div class="source-code"><pre>{ Type =<br> { AccessLogSetting : Optional (<a href="./AccessLogSetting.dhall.html">./AccessLogSetting.dhall</a>).Type<br> , AlwaysDeploy : Optional Bool<br> , Auth : Optional (<a href="./Auth.dhall.html">./Auth.dhall</a>).Type<br> , BinaryMediaTypes : Optional (List (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , CacheClusterEnabled : Optional Bool<br> , CacheClusterSize : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , CanarySetting : Optional (<a href="./CanarySetting.dhall.html">./CanarySetting.dhall</a>).Type<br> , Cors : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , DefinitionBody : Optional (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).JSON.Type<br> , DefinitionUri : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , Description : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , DisableExecuteApiEndpoint : Optional Bool<br> , Domain : Optional (<a href="./DomainConfiguration.dhall.html">./DomainConfiguration.dhall</a>).Type<br> , EndpointConfiguration : Optional (<a href="./EndpointConfiguration.dhall.html">./EndpointConfiguration.dhall</a>).Type<br> , GatewayResponses :<br> Optional<br> ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , MethodSettings : Optional (List (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).JSON.Type)<br> , MinimumCompressionSize : Optional Integer<br> , Models :<br> Optional<br> ( (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type<br> Text<br> ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text Text)<br> )<br> , Name : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , OpenApiVersion : Optional (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , StageName : (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , Tags :<br> Optional<br> ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , TracingEnabled : Optional Bool<br> , Variables :<br> Optional<br> ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> }<br>, default =<br> { AccessLogSetting = None (<a href="./AccessLogSetting.dhall.html">./AccessLogSetting.dhall</a>).Type<br> , AlwaysDeploy = None Bool<br> , Auth = None (<a href="./Auth.dhall.html">./Auth.dhall</a>).Type<br> , BinaryMediaTypes = None (List (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , CacheClusterEnabled = None Bool<br> , CacheClusterSize = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , CanarySetting = None (<a href="./CanarySetting.dhall.html">./CanarySetting.dhall</a>).Type<br> , Cors = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , DefinitionBody = None (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).JSON.Type<br> , DefinitionUri = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , Description = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , DisableExecuteApiEndpoint = None Bool<br> , Domain = None (<a href="./DomainConfiguration.dhall.html">./DomainConfiguration.dhall</a>).Type<br> , EndpointConfiguration = None (<a href="./EndpointConfiguration.dhall.html">./EndpointConfiguration.dhall</a>).Type<br> , GatewayResponses =<br> None ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , MethodSettings = None (List (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).JSON.Type)<br> , MinimumCompressionSize = None Integer<br> , Models =<br> None<br> ( (<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type<br> Text<br> ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text Text)<br> )<br> , Name = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , OpenApiVersion = None (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText<br> , Tags =<br> None ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> , TracingEnabled = None Bool<br> , Variables =<br> None ((<a href="./../../Prelude.dhall.html">./../../Prelude.dhall</a>).Map.Type Text (<a href="./../../Fn.dhall.html">./../../Fn.dhall</a>).CfnText)<br> }<br>}<br></pre></div></div></body></html>