Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a new Stage
resource that references a pre-existing Deployment
for the API.
Synopsis
- createStage :: Text -> Text -> Text -> CreateStage
- data CreateStage
- cVariables :: Lens' CreateStage (HashMap Text Text)
- cDocumentationVersion :: Lens' CreateStage (Maybe Text)
- cCacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize)
- cCanarySettings :: Lens' CreateStage (Maybe CanarySettings)
- cCacheClusterEnabled :: Lens' CreateStage (Maybe Bool)
- cDescription :: Lens' CreateStage (Maybe Text)
- cTags :: Lens' CreateStage (HashMap Text Text)
- cRestAPIId :: Lens' CreateStage Text
- cStageName :: Lens' CreateStage Text
- cDeploymentId :: Lens' CreateStage Text
- stage :: Stage
- data Stage
- sDeploymentId :: Lens' Stage (Maybe Text)
- sVariables :: Lens' Stage (HashMap Text Text)
- sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- sDocumentationVersion :: Lens' Stage (Maybe Text)
- sClientCertificateId :: Lens' Stage (Maybe Text)
- sCreatedDate :: Lens' Stage (Maybe UTCTime)
- sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)
- sMethodSettings :: Lens' Stage (HashMap Text MethodSetting)
- sLastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)
- sCanarySettings :: Lens' Stage (Maybe CanarySettings)
- sCacheClusterEnabled :: Lens' Stage (Maybe Bool)
- sStageName :: Lens' Stage (Maybe Text)
- sDescription :: Lens' Stage (Maybe Text)
- sTags :: Lens' Stage (HashMap Text Text)
Creating a Request
Creates a value of CreateStage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cVariables
- A map that defines the stage variables for the newStage
resource. Variable names can have alphanumeric and underscore characters, and the values must match[A-Za-z0-9-._~:/?#&=,]+
.cDocumentationVersion
- The version of the associated API documentation.cCacheClusterSize
- The stage's cache cluster size.cCanarySettings
- The canary deployment settings of this stage.cCacheClusterEnabled
- Whether cache clustering is enabled for the stage.cDescription
- The description of theStage
resource.cTags
- The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start withaws:
. The tag value can be up to 256 characters.cRestAPIId
- [Required] The string identifier of the associatedRestApi
.cStageName
- [Required] The name for theStage
resource.cDeploymentId
- [Required] The identifier of theDeployment
resource for theStage
resource.
data CreateStage Source #
Requests API Gateway to create a Stage
resource.
See: createStage
smart constructor.
Instances
Request Lenses
cVariables :: Lens' CreateStage (HashMap Text Text) Source #
A map that defines the stage variables for the new Stage
resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.
cDocumentationVersion :: Lens' CreateStage (Maybe Text) Source #
The version of the associated API documentation.
cCacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize) Source #
The stage's cache cluster size.
cCanarySettings :: Lens' CreateStage (Maybe CanarySettings) Source #
The canary deployment settings of this stage.
cCacheClusterEnabled :: Lens' CreateStage (Maybe Bool) Source #
Whether cache clustering is enabled for the stage.
cDescription :: Lens' CreateStage (Maybe Text) Source #
The description of the Stage
resource.
cTags :: Lens' CreateStage (HashMap Text Text) Source #
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:
. The tag value can be up to 256 characters.
cRestAPIId :: Lens' CreateStage Text Source #
- Required
- The string identifier of the associated
RestApi
.
cStageName :: Lens' CreateStage Text Source #
- Required
- The name for the
Stage
resource.
cDeploymentId :: Lens' CreateStage Text Source #
- Required
- The identifier of the
Deployment
resource for theStage
resource.
Destructuring the Response
Creates a value of Stage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sDeploymentId
- The identifier of theDeployment
that the stage points to.sVariables
- A map that defines the stage variables for aStage
resource. Variable names can have alphanumeric and underscore characters, and the values must match[A-Za-z0-9-._~:/?#&=,]+
.sAccessLogSettings
- Settings for logging access in this stage.sDocumentationVersion
- The version of the associated API documentation.sClientCertificateId
- The identifier of a client certificate for an API stage.sCreatedDate
- The timestamp when the stage was created.sCacheClusterStatus
- The status of the cache cluster for the stage, if enabled.sMethodSettings
- A map that defines the method settings for aStage
resource. Keys (designated as/{method_setting_key
below) are method paths defined as{resource_path}/{http_method}
for an individual method override, or**
for overriding all methods in the stage.sLastUpdatedDate
- The timestamp when the stage last updated.sCacheClusterSize
- The size of the cache cluster for the stage, if enabled.sCanarySettings
- Settings for the canary deployment in this stage.sCacheClusterEnabled
- Specifies whether a cache cluster is enabled for the stage.sStageName
- The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.sDescription
- The stage's description.sTags
- The collection of tags. Each tag element is associated with a given resource.
Represents a unique identifier for a version of a deployed RestApi
that is callable by users.
See: stage
smart constructor.
Instances
Response Lenses
sDeploymentId :: Lens' Stage (Maybe Text) Source #
The identifier of the Deployment
that the stage points to.
sVariables :: Lens' Stage (HashMap Text Text) Source #
A map that defines the stage variables for a Stage
resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.
sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
sDocumentationVersion :: Lens' Stage (Maybe Text) Source #
The version of the associated API documentation.
sClientCertificateId :: Lens' Stage (Maybe Text) Source #
The identifier of a client certificate for an API stage.
sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #
The status of the cache cluster for the stage, if enabled.
sMethodSettings :: Lens' Stage (HashMap Text MethodSetting) Source #
A map that defines the method settings for a Stage
resource. Keys (designated as /{method_setting_key
below) are method paths defined as {resource_path}/{http_method}
for an individual method override, or **
for overriding all methods in the stage.
sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #
The size of the cache cluster for the stage, if enabled.
sCanarySettings :: Lens' Stage (Maybe CanarySettings) Source #
Settings for the canary deployment in this stage.
sCacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #
Specifies whether a cache cluster is enabled for the stage.