Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
See: AWS API Reference for CreateDeployment.
- createDeployment :: Text -> Text -> CreateDeployment
- data CreateDeployment
- cdStageDescription :: Lens' CreateDeployment (Maybe Text)
- cdVariables :: Lens' CreateDeployment (HashMap Text Text)
- cdCacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize)
- cdCacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)
- cdDescription :: Lens' CreateDeployment (Maybe Text)
- cdRestAPIId :: Lens' CreateDeployment Text
- cdStageName :: Lens' CreateDeployment Text
- deployment :: Deployment
- data Deployment
- dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot))
- dCreatedDate :: Lens' Deployment (Maybe UTCTime)
- dId :: Lens' Deployment (Maybe Text)
- dDescription :: Lens' Deployment (Maybe Text)
Creating a Request
Creates a value of CreateDeployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CreateDeployment Source
Requests Amazon API Gateway to create a Deployment resource.
See: createDeployment
smart constructor.
Request Lenses
cdStageDescription :: Lens' CreateDeployment (Maybe Text) Source
The description of the Stage resource for the Deployment resource to create.
cdVariables :: Lens' CreateDeployment (HashMap Text Text) Source
A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
cdCacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize) Source
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
cdCacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool) Source
Enables a cache cluster for the Stage resource specified in the input.
cdDescription :: Lens' CreateDeployment (Maybe Text) Source
The description for the Deployment resource to create.
cdRestAPIId :: Lens' CreateDeployment Text Source
The RestApi resource identifier for the Deployment resource to create.
cdStageName :: Lens' CreateDeployment Text Source
The name of the Stage resource for the Deployment resource to create.
Destructuring the Response
deployment :: Deployment Source
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data Deployment Source
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
See: deployment
smart constructor.
Response Lenses
dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot)) Source
Gets a summary of the RestApi at the date and time that the deployment resource was created.
dCreatedDate :: Lens' Deployment (Maybe UTCTime) Source
The date and time that the deployment resource was created.
dDescription :: Lens' Deployment (Maybe Text) Source
The description for the deployment resource.