| Copyright | (c) 2013-2021 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 |
Amazonka.APIGateway.CreateStage
Description
Creates a new Stage resource that references a pre-existing Deployment for the API.
Synopsis
- data CreateStage = CreateStage' {
- variables :: Maybe (HashMap Text Text)
- documentationVersion :: Maybe Text
- tracingEnabled :: Maybe Bool
- cacheClusterSize :: Maybe CacheClusterSize
- canarySettings :: Maybe CanarySettings
- cacheClusterEnabled :: Maybe Bool
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- restApiId :: Text
- stageName :: Text
- deploymentId :: Text
- newCreateStage :: Text -> Text -> Text -> CreateStage
- createStage_variables :: Lens' CreateStage (Maybe (HashMap Text Text))
- createStage_documentationVersion :: Lens' CreateStage (Maybe Text)
- createStage_tracingEnabled :: Lens' CreateStage (Maybe Bool)
- createStage_cacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize)
- createStage_canarySettings :: Lens' CreateStage (Maybe CanarySettings)
- createStage_cacheClusterEnabled :: Lens' CreateStage (Maybe Bool)
- createStage_description :: Lens' CreateStage (Maybe Text)
- createStage_tags :: Lens' CreateStage (Maybe (HashMap Text Text))
- createStage_restApiId :: Lens' CreateStage Text
- createStage_stageName :: Lens' CreateStage Text
- createStage_deploymentId :: Lens' CreateStage Text
- data Stage = Stage' {
- deploymentId :: Maybe Text
- variables :: Maybe (HashMap Text Text)
- accessLogSettings :: Maybe AccessLogSettings
- documentationVersion :: Maybe Text
- clientCertificateId :: Maybe Text
- tracingEnabled :: Maybe Bool
- createdDate :: Maybe POSIX
- cacheClusterStatus :: Maybe CacheClusterStatus
- methodSettings :: Maybe (HashMap Text MethodSetting)
- lastUpdatedDate :: Maybe POSIX
- cacheClusterSize :: Maybe CacheClusterSize
- webAclArn :: Maybe Text
- canarySettings :: Maybe CanarySettings
- cacheClusterEnabled :: Maybe Bool
- stageName :: Maybe Text
- description :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- newStage :: Stage
- stage_deploymentId :: Lens' Stage (Maybe Text)
- stage_variables :: Lens' Stage (Maybe (HashMap Text Text))
- stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- stage_documentationVersion :: Lens' Stage (Maybe Text)
- stage_clientCertificateId :: Lens' Stage (Maybe Text)
- stage_tracingEnabled :: Lens' Stage (Maybe Bool)
- stage_createdDate :: Lens' Stage (Maybe UTCTime)
- stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)
- stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting))
- stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)
- stage_webAclArn :: Lens' Stage (Maybe Text)
- stage_canarySettings :: Lens' Stage (Maybe CanarySettings)
- stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool)
- stage_stageName :: Lens' Stage (Maybe Text)
- stage_description :: Lens' Stage (Maybe Text)
- stage_tags :: Lens' Stage (Maybe (HashMap Text Text))
Creating a Request
data CreateStage Source #
Requests API Gateway to create a Stage resource.
See: newCreateStage smart constructor.
Constructors
| CreateStage' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateStage |
Create a value of CreateStage 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:variables:CreateStage', createStage_variables - 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-._~:/?#&=,]+.
$sel:documentationVersion:CreateStage', createStage_documentationVersion - The version of the associated API documentation.
$sel:tracingEnabled:CreateStage', createStage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
$sel:cacheClusterSize:CreateStage', createStage_cacheClusterSize - The stage's cache cluster size.
$sel:canarySettings:CreateStage', createStage_canarySettings - The canary deployment settings of this stage.
$sel:cacheClusterEnabled:CreateStage', createStage_cacheClusterEnabled - Whether cache clustering is enabled for the stage.
$sel:description:CreateStage', createStage_description - The description of the Stage resource.
$sel:tags:CreateStage', createStage_tags - 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.
$sel:restApiId:CreateStage', createStage_restApiId - [Required] The string identifier of the associated RestApi.
$sel:stageName:CreateStage', createStage_stageName - [Required] The name for the Stage resource. Stage names can only contain
alphanumeric characters, hyphens, and underscores. Maximum length is 128
characters.
$sel:deploymentId:CreateStage', createStage_deploymentId - [Required] The identifier of the Deployment resource for the Stage
resource.
Request Lenses
createStage_variables :: Lens' CreateStage (Maybe (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-._~:/?#&=,]+.
createStage_documentationVersion :: Lens' CreateStage (Maybe Text) Source #
The version of the associated API documentation.
createStage_tracingEnabled :: Lens' CreateStage (Maybe Bool) Source #
Specifies whether active tracing with X-ray is enabled for the Stage.
createStage_cacheClusterSize :: Lens' CreateStage (Maybe CacheClusterSize) Source #
The stage's cache cluster size.
createStage_canarySettings :: Lens' CreateStage (Maybe CanarySettings) Source #
The canary deployment settings of this stage.
createStage_cacheClusterEnabled :: Lens' CreateStage (Maybe Bool) Source #
Whether cache clustering is enabled for the stage.
createStage_description :: Lens' CreateStage (Maybe Text) Source #
The description of the Stage resource.
createStage_tags :: Lens' CreateStage (Maybe (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.
createStage_restApiId :: Lens' CreateStage Text Source #
- Required
- The string identifier of the associated RestApi.
createStage_stageName :: Lens' CreateStage Text Source #
- Required
- The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
createStage_deploymentId :: Lens' CreateStage Text Source #
- Required
- The identifier of the Deployment resource for the Stage resource.
Destructuring the Response
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
See: newStage smart constructor.
Constructors
| Stage' | |
Fields
| |
Instances
Create a value of Stage 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:deploymentId:Stage', stage_deploymentId - The identifier of the Deployment that the stage points to.
$sel:variables:Stage', stage_variables - 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-._~:/?#&=,]+.
$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.
$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.
$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.
$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.
$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
$sel:methodSettings:Stage', stage_methodSettings - 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.
$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.
$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The size of the cache cluster for the stage, if enabled.
$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.
$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.
$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.
$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource
Identifier (URI) of a call to API Gateway. Stage names can only contain
alphanumeric characters, hyphens, and underscores. Maximum length is 128
characters.
$sel:description:Stage', stage_description - The stage's description.
$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given
resource.
Response Lenses
stage_deploymentId :: Lens' Stage (Maybe Text) Source #
The identifier of the Deployment that the stage points to.
stage_variables :: Lens' Stage (Maybe (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-._~:/?#&=,]+.
stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
stage_documentationVersion :: Lens' Stage (Maybe Text) Source #
The version of the associated API documentation.
stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #
The identifier of a client certificate for an API stage.
stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #
Specifies whether active tracing with X-ray is enabled for the Stage.
stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #
The status of the cache cluster for the stage, if enabled.
stage_methodSettings :: Lens' Stage (Maybe (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.
stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #
The timestamp when the stage last updated.
stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #
The size of the cache cluster for the stage, if enabled.
stage_webAclArn :: Lens' Stage (Maybe Text) Source #
The ARN of the WebAcl associated with the Stage.
stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #
Settings for the canary deployment in this stage.
stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #
Specifies whether a cache cluster is enabled for the stage.