Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a Deployment resource, which makes a specified RestApi callable over the internet.
Synopsis
- data CreateDeployment = CreateDeployment' {}
- newCreateDeployment :: Text -> CreateDeployment
- createDeployment_cacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)
- createDeployment_cacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize)
- createDeployment_canarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings)
- createDeployment_description :: Lens' CreateDeployment (Maybe Text)
- createDeployment_stageDescription :: Lens' CreateDeployment (Maybe Text)
- createDeployment_stageName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_tracingEnabled :: Lens' CreateDeployment (Maybe Bool)
- createDeployment_variables :: Lens' CreateDeployment (Maybe (HashMap Text Text))
- createDeployment_restApiId :: Lens' CreateDeployment Text
- data Deployment = Deployment' {
- apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))
- createdDate :: Maybe POSIX
- description :: Maybe Text
- id :: Maybe Text
- newDeployment :: Deployment
- deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_description :: Lens' Deployment (Maybe Text)
- deployment_id :: Lens' Deployment (Maybe Text)
Creating a Request
data CreateDeployment Source #
Requests API Gateway to create a Deployment resource.
See: newCreateDeployment
smart constructor.
CreateDeployment' | |
|
Instances
Create a value of CreateDeployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeployment
, createDeployment_cacheClusterEnabled
- Enables a cache cluster for the Stage resource specified in the input.
CreateDeployment
, createDeployment_cacheClusterSize
- The stage's cache capacity in GB. For more information about choosing a
cache size, see
Enabling API caching to enhance responsiveness.
CreateDeployment
, createDeployment_canarySettings
- The input configuration for the canary deployment when the deployment is
a canary release deployment.
CreateDeployment
, createDeployment_description
- The description for the Deployment resource to create.
$sel:stageDescription:CreateDeployment'
, createDeployment_stageDescription
- The description of the Stage resource for the Deployment resource to
create.
CreateDeployment
, createDeployment_stageName
- The name of the Stage resource for the Deployment resource to create.
CreateDeployment
, createDeployment_tracingEnabled
- Specifies whether active tracing with X-ray is enabled for the Stage.
CreateDeployment
, createDeployment_variables
- A map that defines the stage variables for the Stage resource that is
associated with the new deployment. Variable names can have alphanumeric
and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.
CreateDeployment
, createDeployment_restApiId
- The string identifier of the associated RestApi.
Request Lenses
createDeployment_cacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool) Source #
Enables a cache cluster for the Stage resource specified in the input.
createDeployment_cacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize) Source #
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
createDeployment_canarySettings :: Lens' CreateDeployment (Maybe DeploymentCanarySettings) Source #
The input configuration for the canary deployment when the deployment is a canary release deployment.
createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #
The description for the Deployment resource to create.
createDeployment_stageDescription :: Lens' CreateDeployment (Maybe Text) Source #
The description of the Stage resource for the Deployment resource to create.
createDeployment_stageName :: Lens' CreateDeployment (Maybe Text) Source #
The name of the Stage resource for the Deployment resource to create.
createDeployment_tracingEnabled :: Lens' CreateDeployment (Maybe Bool) Source #
Specifies whether active tracing with X-ray is enabled for the Stage.
createDeployment_variables :: Lens' CreateDeployment (Maybe (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 alphanumeric
and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.
createDeployment_restApiId :: Lens' CreateDeployment Text Source #
The string identifier of the associated RestApi.
Destructuring the Response
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: newDeployment
smart constructor.
Deployment' | |
|
Instances
newDeployment :: Deployment Source #
Create a value of Deployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiSummary:Deployment'
, deployment_apiSummary
- A summary of the RestApi at the date and time that the deployment
resource was created.
$sel:createdDate:Deployment'
, deployment_createdDate
- The date and time that the deployment resource was created.
$sel:description:Deployment'
, deployment_description
- The description for the deployment resource.
$sel:id:Deployment'
, deployment_id
- The identifier for the deployment resource.
Response Lenses
deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #
A summary of the RestApi at the date and time that the deployment resource was created.
deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time that the deployment resource was created.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment resource.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment resource.