| 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 |
Amazonka.ApiGatewayV2.Types
Contents
- Service Configuration
- Errors
- AuthorizationType
- AuthorizerType
- ConnectionType
- ContentHandlingStrategy
- DeploymentStatus
- DomainNameStatus
- EndpointType
- IntegrationType
- LoggingLevel
- PassthroughBehavior
- ProtocolType
- SecurityPolicy
- VpcLinkStatus
- VpcLinkVersion
- AccessLogSettings
- Api
- ApiMapping
- Authorizer
- Cors
- Deployment
- DomainName
- DomainNameConfiguration
- Integration
- IntegrationResponse
- JWTConfiguration
- Model
- MutualTlsAuthentication
- MutualTlsAuthenticationInput
- ParameterConstraints
- Route
- RouteResponse
- RouteSettings
- Stage
- TlsConfig
- TlsConfigInput
- VpcLink
Description
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- newtype AuthorizationType where
- AuthorizationType' { }
- pattern AuthorizationType_AWS_IAM :: AuthorizationType
- pattern AuthorizationType_CUSTOM :: AuthorizationType
- pattern AuthorizationType_JWT :: AuthorizationType
- pattern AuthorizationType_NONE :: AuthorizationType
- newtype AuthorizerType where
- AuthorizerType' { }
- pattern AuthorizerType_JWT :: AuthorizerType
- pattern AuthorizerType_REQUEST :: AuthorizerType
- newtype ConnectionType where
- ConnectionType' { }
- pattern ConnectionType_INTERNET :: ConnectionType
- pattern ConnectionType_VPC_LINK :: ConnectionType
- newtype ContentHandlingStrategy where
- newtype DeploymentStatus where
- DeploymentStatus' { }
- pattern DeploymentStatus_DEPLOYED :: DeploymentStatus
- pattern DeploymentStatus_FAILED :: DeploymentStatus
- pattern DeploymentStatus_PENDING :: DeploymentStatus
- newtype DomainNameStatus where
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_EDGE :: EndpointType
- pattern EndpointType_REGIONAL :: EndpointType
- newtype IntegrationType where
- IntegrationType' { }
- pattern IntegrationType_AWS :: IntegrationType
- pattern IntegrationType_AWS_PROXY :: IntegrationType
- pattern IntegrationType_HTTP :: IntegrationType
- pattern IntegrationType_HTTP_PROXY :: IntegrationType
- pattern IntegrationType_MOCK :: IntegrationType
- newtype LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_ERROR :: LoggingLevel
- pattern LoggingLevel_INFO :: LoggingLevel
- pattern LoggingLevel_OFF :: LoggingLevel
- newtype PassthroughBehavior where
- newtype ProtocolType where
- ProtocolType' { }
- pattern ProtocolType_HTTP :: ProtocolType
- pattern ProtocolType_WEBSOCKET :: ProtocolType
- newtype SecurityPolicy where
- SecurityPolicy' { }
- pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy
- pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy
- newtype VpcLinkStatus where
- VpcLinkStatus' { }
- pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus
- pattern VpcLinkStatus_DELETING :: VpcLinkStatus
- pattern VpcLinkStatus_FAILED :: VpcLinkStatus
- pattern VpcLinkStatus_INACTIVE :: VpcLinkStatus
- pattern VpcLinkStatus_PENDING :: VpcLinkStatus
- newtype VpcLinkVersion where
- VpcLinkVersion' { }
- pattern VpcLinkVersion_V2 :: VpcLinkVersion
- data AccessLogSettings = AccessLogSettings' {}
- newAccessLogSettings :: AccessLogSettings
- accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text)
- accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text)
- data Api = Api' {
- apiEndpoint :: Maybe Text
- apiGatewayManaged :: Maybe Bool
- apiId :: Maybe Text
- apiKeySelectionExpression :: Maybe Text
- corsConfiguration :: Maybe Cors
- createdDate :: Maybe ISO8601
- description :: Maybe Text
- disableExecuteApiEndpoint :: Maybe Bool
- disableSchemaValidation :: Maybe Bool
- importInfo :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
- version :: Maybe Text
- warnings :: Maybe [Text]
- routeSelectionExpression :: Text
- name :: Text
- protocolType :: ProtocolType
- newApi :: Text -> Text -> ProtocolType -> Api
- api_apiEndpoint :: Lens' Api (Maybe Text)
- api_apiGatewayManaged :: Lens' Api (Maybe Bool)
- api_apiId :: Lens' Api (Maybe Text)
- api_apiKeySelectionExpression :: Lens' Api (Maybe Text)
- api_corsConfiguration :: Lens' Api (Maybe Cors)
- api_createdDate :: Lens' Api (Maybe UTCTime)
- api_description :: Lens' Api (Maybe Text)
- api_disableExecuteApiEndpoint :: Lens' Api (Maybe Bool)
- api_disableSchemaValidation :: Lens' Api (Maybe Bool)
- api_importInfo :: Lens' Api (Maybe [Text])
- api_tags :: Lens' Api (Maybe (HashMap Text Text))
- api_version :: Lens' Api (Maybe Text)
- api_warnings :: Lens' Api (Maybe [Text])
- api_routeSelectionExpression :: Lens' Api Text
- api_name :: Lens' Api Text
- api_protocolType :: Lens' Api ProtocolType
- data ApiMapping = ApiMapping' {
- apiMappingId :: Maybe Text
- apiMappingKey :: Maybe Text
- stage :: Text
- apiId :: Text
- newApiMapping :: Text -> Text -> ApiMapping
- apiMapping_apiMappingId :: Lens' ApiMapping (Maybe Text)
- apiMapping_apiMappingKey :: Lens' ApiMapping (Maybe Text)
- apiMapping_stage :: Lens' ApiMapping Text
- apiMapping_apiId :: Lens' ApiMapping Text
- data Authorizer = Authorizer' {
- authorizerCredentialsArn :: Maybe Text
- authorizerId :: Maybe Text
- authorizerPayloadFormatVersion :: Maybe Text
- authorizerResultTtlInSeconds :: Maybe Natural
- authorizerType :: Maybe AuthorizerType
- authorizerUri :: Maybe Text
- enableSimpleResponses :: Maybe Bool
- identitySource :: Maybe [Text]
- identityValidationExpression :: Maybe Text
- jwtConfiguration :: Maybe JWTConfiguration
- name :: Text
- newAuthorizer :: Text -> Authorizer
- authorizer_authorizerCredentialsArn :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerId :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerPayloadFormatVersion :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Natural)
- authorizer_authorizerType :: Lens' Authorizer (Maybe AuthorizerType)
- authorizer_authorizerUri :: Lens' Authorizer (Maybe Text)
- authorizer_enableSimpleResponses :: Lens' Authorizer (Maybe Bool)
- authorizer_identitySource :: Lens' Authorizer (Maybe [Text])
- authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text)
- authorizer_jwtConfiguration :: Lens' Authorizer (Maybe JWTConfiguration)
- authorizer_name :: Lens' Authorizer Text
- data Cors = Cors' {
- allowCredentials :: Maybe Bool
- allowHeaders :: Maybe [Text]
- allowMethods :: Maybe [Text]
- allowOrigins :: Maybe [Text]
- exposeHeaders :: Maybe [Text]
- maxAge :: Maybe Int
- newCors :: Cors
- cors_allowCredentials :: Lens' Cors (Maybe Bool)
- cors_allowHeaders :: Lens' Cors (Maybe [Text])
- cors_allowMethods :: Lens' Cors (Maybe [Text])
- cors_allowOrigins :: Lens' Cors (Maybe [Text])
- cors_exposeHeaders :: Lens' Cors (Maybe [Text])
- cors_maxAge :: Lens' Cors (Maybe Int)
- data Deployment = Deployment' {}
- newDeployment :: Deployment
- deployment_autoDeployed :: Lens' Deployment (Maybe Bool)
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_deploymentId :: Lens' Deployment (Maybe Text)
- deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus)
- deployment_deploymentStatusMessage :: Lens' Deployment (Maybe Text)
- deployment_description :: Lens' Deployment (Maybe Text)
- data DomainName = DomainName' {}
- newDomainName :: Text -> DomainName
- domainName_apiMappingSelectionExpression :: Lens' DomainName (Maybe Text)
- domainName_domainNameConfigurations :: Lens' DomainName (Maybe [DomainNameConfiguration])
- domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication)
- domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text))
- domainName_domainName :: Lens' DomainName Text
- data DomainNameConfiguration = DomainNameConfiguration' {
- apiGatewayDomainName :: Maybe Text
- certificateArn :: Maybe Text
- certificateName :: Maybe Text
- certificateUploadDate :: Maybe ISO8601
- domainNameStatus :: Maybe DomainNameStatus
- domainNameStatusMessage :: Maybe Text
- endpointType :: Maybe EndpointType
- hostedZoneId :: Maybe Text
- ownershipVerificationCertificateArn :: Maybe Text
- securityPolicy :: Maybe SecurityPolicy
- newDomainNameConfiguration :: DomainNameConfiguration
- domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime)
- domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe DomainNameStatus)
- domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType)
- domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe SecurityPolicy)
- data Integration = Integration' {
- apiGatewayManaged :: Maybe Bool
- connectionId :: Maybe Text
- connectionType :: Maybe ConnectionType
- contentHandlingStrategy :: Maybe ContentHandlingStrategy
- credentialsArn :: Maybe Text
- description :: Maybe Text
- integrationId :: Maybe Text
- integrationMethod :: Maybe Text
- integrationResponseSelectionExpression :: Maybe Text
- integrationSubtype :: Maybe Text
- integrationType :: Maybe IntegrationType
- integrationUri :: Maybe Text
- passthroughBehavior :: Maybe PassthroughBehavior
- payloadFormatVersion :: Maybe Text
- requestParameters :: Maybe (HashMap Text Text)
- requestTemplates :: Maybe (HashMap Text Text)
- responseParameters :: Maybe (HashMap Text (HashMap Text Text))
- templateSelectionExpression :: Maybe Text
- timeoutInMillis :: Maybe Natural
- tlsConfig :: Maybe TlsConfig
- newIntegration :: Integration
- integration_apiGatewayManaged :: Lens' Integration (Maybe Bool)
- integration_connectionId :: Lens' Integration (Maybe Text)
- integration_connectionType :: Lens' Integration (Maybe ConnectionType)
- integration_contentHandlingStrategy :: Lens' Integration (Maybe ContentHandlingStrategy)
- integration_credentialsArn :: Lens' Integration (Maybe Text)
- integration_description :: Lens' Integration (Maybe Text)
- integration_integrationId :: Lens' Integration (Maybe Text)
- integration_integrationMethod :: Lens' Integration (Maybe Text)
- integration_integrationResponseSelectionExpression :: Lens' Integration (Maybe Text)
- integration_integrationSubtype :: Lens' Integration (Maybe Text)
- integration_integrationType :: Lens' Integration (Maybe IntegrationType)
- integration_integrationUri :: Lens' Integration (Maybe Text)
- integration_passthroughBehavior :: Lens' Integration (Maybe PassthroughBehavior)
- integration_payloadFormatVersion :: Lens' Integration (Maybe Text)
- integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text))
- integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text))
- integration_responseParameters :: Lens' Integration (Maybe (HashMap Text (HashMap Text Text)))
- integration_templateSelectionExpression :: Lens' Integration (Maybe Text)
- integration_timeoutInMillis :: Lens' Integration (Maybe Natural)
- integration_tlsConfig :: Lens' Integration (Maybe TlsConfig)
- data IntegrationResponse = IntegrationResponse' {}
- newIntegrationResponse :: Text -> IntegrationResponse
- integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
- integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text)
- integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text)
- integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text
- data JWTConfiguration = JWTConfiguration' {}
- newJWTConfiguration :: JWTConfiguration
- jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text])
- jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text)
- data Model = Model' {}
- newModel :: Text -> Model
- model_contentType :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_modelId :: Lens' Model (Maybe Text)
- model_schema :: Lens' Model (Maybe Text)
- model_name :: Lens' Model Text
- data MutualTlsAuthentication = MutualTlsAuthentication' {}
- newMutualTlsAuthentication :: MutualTlsAuthentication
- mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text])
- data MutualTlsAuthenticationInput = MutualTlsAuthenticationInput' {}
- newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput
- mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- data ParameterConstraints = ParameterConstraints' {}
- newParameterConstraints :: ParameterConstraints
- parameterConstraints_required :: Lens' ParameterConstraints (Maybe Bool)
- data Route = Route' {
- apiGatewayManaged :: Maybe Bool
- apiKeyRequired :: Maybe Bool
- authorizationScopes :: Maybe [Text]
- authorizationType :: Maybe AuthorizationType
- authorizerId :: Maybe Text
- modelSelectionExpression :: Maybe Text
- operationName :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- requestParameters :: Maybe (HashMap Text ParameterConstraints)
- routeId :: Maybe Text
- routeResponseSelectionExpression :: Maybe Text
- target :: Maybe Text
- routeKey :: Text
- newRoute :: Text -> Route
- route_apiGatewayManaged :: Lens' Route (Maybe Bool)
- route_apiKeyRequired :: Lens' Route (Maybe Bool)
- route_authorizationScopes :: Lens' Route (Maybe [Text])
- route_authorizationType :: Lens' Route (Maybe AuthorizationType)
- route_authorizerId :: Lens' Route (Maybe Text)
- route_modelSelectionExpression :: Lens' Route (Maybe Text)
- route_operationName :: Lens' Route (Maybe Text)
- route_requestModels :: Lens' Route (Maybe (HashMap Text Text))
- route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints))
- route_routeId :: Lens' Route (Maybe Text)
- route_routeResponseSelectionExpression :: Lens' Route (Maybe Text)
- route_target :: Lens' Route (Maybe Text)
- route_routeKey :: Lens' Route Text
- data RouteResponse = RouteResponse' {}
- newRouteResponse :: Text -> RouteResponse
- routeResponse_modelSelectionExpression :: Lens' RouteResponse (Maybe Text)
- routeResponse_responseModels :: Lens' RouteResponse (Maybe (HashMap Text Text))
- routeResponse_responseParameters :: Lens' RouteResponse (Maybe (HashMap Text ParameterConstraints))
- routeResponse_routeResponseId :: Lens' RouteResponse (Maybe Text)
- routeResponse_routeResponseKey :: Lens' RouteResponse Text
- data RouteSettings = RouteSettings' {}
- newRouteSettings :: RouteSettings
- routeSettings_dataTraceEnabled :: Lens' RouteSettings (Maybe Bool)
- routeSettings_detailedMetricsEnabled :: Lens' RouteSettings (Maybe Bool)
- routeSettings_loggingLevel :: Lens' RouteSettings (Maybe LoggingLevel)
- routeSettings_throttlingBurstLimit :: Lens' RouteSettings (Maybe Int)
- routeSettings_throttlingRateLimit :: Lens' RouteSettings (Maybe Double)
- data Stage = Stage' {
- accessLogSettings :: Maybe AccessLogSettings
- apiGatewayManaged :: Maybe Bool
- autoDeploy :: Maybe Bool
- clientCertificateId :: Maybe Text
- createdDate :: Maybe ISO8601
- defaultRouteSettings :: Maybe RouteSettings
- deploymentId :: Maybe Text
- description :: Maybe Text
- lastDeploymentStatusMessage :: Maybe Text
- lastUpdatedDate :: Maybe ISO8601
- routeSettings :: Maybe (HashMap Text RouteSettings)
- stageVariables :: Maybe (HashMap Text Text)
- tags :: Maybe (HashMap Text Text)
- stageName :: Text
- newStage :: Text -> Stage
- stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- stage_apiGatewayManaged :: Lens' Stage (Maybe Bool)
- stage_autoDeploy :: Lens' Stage (Maybe Bool)
- stage_clientCertificateId :: Lens' Stage (Maybe Text)
- stage_createdDate :: Lens' Stage (Maybe UTCTime)
- stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings)
- stage_deploymentId :: Lens' Stage (Maybe Text)
- stage_description :: Lens' Stage (Maybe Text)
- stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text)
- stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings))
- stage_stageVariables :: Lens' Stage (Maybe (HashMap Text Text))
- stage_tags :: Lens' Stage (Maybe (HashMap Text Text))
- stage_stageName :: Lens' Stage Text
- data TlsConfig = TlsConfig' {}
- newTlsConfig :: TlsConfig
- tlsConfig_serverNameToVerify :: Lens' TlsConfig (Maybe Text)
- data TlsConfigInput = TlsConfigInput' {}
- newTlsConfigInput :: TlsConfigInput
- tlsConfigInput_serverNameToVerify :: Lens' TlsConfigInput (Maybe Text)
- data VpcLink = VpcLink' {
- createdDate :: Maybe ISO8601
- tags :: Maybe (HashMap Text Text)
- vpcLinkStatus :: Maybe VpcLinkStatus
- vpcLinkStatusMessage :: Maybe Text
- vpcLinkVersion :: Maybe VpcLinkVersion
- vpcLinkId :: Text
- securityGroupIds :: [Text]
- subnetIds :: [Text]
- name :: Text
- newVpcLink :: Text -> Text -> VpcLink
- vpcLink_createdDate :: Lens' VpcLink (Maybe UTCTime)
- vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text))
- vpcLink_vpcLinkStatus :: Lens' VpcLink (Maybe VpcLinkStatus)
- vpcLink_vpcLinkStatusMessage :: Lens' VpcLink (Maybe Text)
- vpcLink_vpcLinkVersion :: Lens' VpcLink (Maybe VpcLinkVersion)
- vpcLink_vpcLinkId :: Lens' VpcLink Text
- vpcLink_securityGroupIds :: Lens' VpcLink [Text]
- vpcLink_subnetIds :: Lens' VpcLink [Text]
- vpcLink_name :: Lens' VpcLink Text
Service Configuration
defaultService :: Service Source #
API version 2018-11-29 of the Amazon ApiGatewayV2 SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Prism for AccessDeniedException' errors.
_BadRequestException :: AsError a => Fold a ServiceError Source #
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
_ConflictException :: AsError a => Fold a ServiceError Source #
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found. See the message field for more information.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
A limit has been exceeded. See the accompanying error message for details.
AuthorizationType
newtype AuthorizationType Source #
The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
Constructors
| AuthorizationType' | |
Fields | |
Bundled Patterns
| pattern AuthorizationType_AWS_IAM :: AuthorizationType | |
| pattern AuthorizationType_CUSTOM :: AuthorizationType | |
| pattern AuthorizationType_JWT :: AuthorizationType | |
| pattern AuthorizationType_NONE :: AuthorizationType |
Instances
AuthorizerType
newtype AuthorizerType Source #
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
Constructors
| AuthorizerType' | |
Fields | |
Bundled Patterns
| pattern AuthorizerType_JWT :: AuthorizerType | |
| pattern AuthorizerType_REQUEST :: AuthorizerType |
Instances
ConnectionType
newtype ConnectionType Source #
Represents a connection type.
Constructors
| ConnectionType' | |
Fields | |
Bundled Patterns
| pattern ConnectionType_INTERNET :: ConnectionType | |
| pattern ConnectionType_VPC_LINK :: ConnectionType |
Instances
ContentHandlingStrategy
newtype ContentHandlingStrategy Source #
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
Constructors
| ContentHandlingStrategy' | |
Fields | |
Bundled Patterns
| pattern ContentHandlingStrategy_CONVERT_TO_BINARY :: ContentHandlingStrategy | |
| pattern ContentHandlingStrategy_CONVERT_TO_TEXT :: ContentHandlingStrategy |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
Represents a deployment status.
Constructors
| DeploymentStatus' | |
Fields | |
Bundled Patterns
| pattern DeploymentStatus_DEPLOYED :: DeploymentStatus | |
| pattern DeploymentStatus_FAILED :: DeploymentStatus | |
| pattern DeploymentStatus_PENDING :: DeploymentStatus |
Instances
DomainNameStatus
newtype DomainNameStatus Source #
The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
Constructors
| DomainNameStatus' | |
Fields | |
Bundled Patterns
Instances
EndpointType
newtype EndpointType Source #
Represents an endpoint type.
Constructors
| EndpointType' | |
Fields | |
Bundled Patterns
| pattern EndpointType_EDGE :: EndpointType | |
| pattern EndpointType_REGIONAL :: EndpointType |
Instances
IntegrationType
newtype IntegrationType Source #
Represents an API method integration type.
Constructors
| IntegrationType' | |
Fields | |
Bundled Patterns
| pattern IntegrationType_AWS :: IntegrationType | |
| pattern IntegrationType_AWS_PROXY :: IntegrationType | |
| pattern IntegrationType_HTTP :: IntegrationType | |
| pattern IntegrationType_HTTP_PROXY :: IntegrationType | |
| pattern IntegrationType_MOCK :: IntegrationType |
Instances
LoggingLevel
newtype LoggingLevel Source #
The logging level.
Constructors
| LoggingLevel' | |
Fields | |
Bundled Patterns
| pattern LoggingLevel_ERROR :: LoggingLevel | |
| pattern LoggingLevel_INFO :: LoggingLevel | |
| pattern LoggingLevel_OFF :: LoggingLevel |
Instances
PassthroughBehavior
newtype PassthroughBehavior Source #
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
Constructors
| PassthroughBehavior' | |
Fields | |
Bundled Patterns
| pattern PassthroughBehavior_NEVER :: PassthroughBehavior | |
| pattern PassthroughBehavior_WHEN_NO_MATCH :: PassthroughBehavior | |
| pattern PassthroughBehavior_WHEN_NO_TEMPLATES :: PassthroughBehavior |
Instances
ProtocolType
newtype ProtocolType Source #
Represents a protocol type.
Constructors
| ProtocolType' | |
Fields | |
Bundled Patterns
| pattern ProtocolType_HTTP :: ProtocolType | |
| pattern ProtocolType_WEBSOCKET :: ProtocolType |
Instances
SecurityPolicy
newtype SecurityPolicy Source #
The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
Constructors
| SecurityPolicy' | |
Fields | |
Bundled Patterns
| pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy | |
| pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy |
Instances
VpcLinkStatus
newtype VpcLinkStatus Source #
The status of the VPC link.
Constructors
| VpcLinkStatus' | |
Fields | |
Bundled Patterns
| pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus | |
| pattern VpcLinkStatus_DELETING :: VpcLinkStatus | |
| pattern VpcLinkStatus_FAILED :: VpcLinkStatus | |
| pattern VpcLinkStatus_INACTIVE :: VpcLinkStatus | |
| pattern VpcLinkStatus_PENDING :: VpcLinkStatus |
Instances
VpcLinkVersion
newtype VpcLinkVersion Source #
The version of the VPC link.
Constructors
| VpcLinkVersion' | |
Fields | |
Bundled Patterns
| pattern VpcLinkVersion_V2 :: VpcLinkVersion |
Instances
AccessLogSettings
data AccessLogSettings Source #
Settings for logging access in a stage.
See: newAccessLogSettings smart constructor.
Constructors
| AccessLogSettings' | |
Instances
newAccessLogSettings :: AccessLogSettings Source #
Create a value of AccessLogSettings 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:destinationArn:AccessLogSettings', accessLogSettings_destinationArn - The ARN of the CloudWatch Logs log group to receive access logs.
$sel:format:AccessLogSettings', accessLogSettings_format - A single line format of the access logs of data, as specified by
selected $context variables. The format must include at least
$context.requestId.
accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text) Source #
The ARN of the CloudWatch Logs log group to receive access logs.
accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text) Source #
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Api
Represents an API.
See: newApi smart constructor.
Constructors
| Api' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ProtocolType | |
| -> Api |
Create a value of Api 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:apiEndpoint:Api', api_apiEndpoint - The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
$sel:apiGatewayManaged:Api', api_apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
$sel:apiId:Api', api_apiId - The API ID.
$sel:apiKeySelectionExpression:Api', api_apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
$sel:corsConfiguration:Api', api_corsConfiguration - A CORS configuration. Supported only for HTTP APIs.
$sel:createdDate:Api', api_createdDate - The timestamp when the API was created.
$sel:description:Api', api_description - The description of the API.
$sel:disableExecuteApiEndpoint:Api', api_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default
execute-api endpoint. By default, clients can invoke your API with the
default https://{api_id}.execute-api.{region}.amazonaws.com endpoint.
To require that clients use a custom domain name to invoke your API,
disable the default endpoint.
$sel:disableSchemaValidation:Api', api_disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
$sel:importInfo:Api', api_importInfo - The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
$sel:tags:Api', api_tags - A collection of tags associated with the API.
$sel:version:Api', api_version - A version identifier for the API.
$sel:warnings:Api', api_warnings - The warning messages reported when failonwarnings is turned on during
API import.
$sel:routeSelectionExpression:Api', api_routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
$sel:name:Api', api_name - The name of the API.
$sel:protocolType:Api', api_protocolType - The API protocol.
api_apiEndpoint :: Lens' Api (Maybe Text) Source #
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
api_apiGatewayManaged :: Lens' Api (Maybe Bool) Source #
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
api_apiKeySelectionExpression :: Lens' Api (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
api_corsConfiguration :: Lens' Api (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
api_disableExecuteApiEndpoint :: Lens' Api (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
api_disableSchemaValidation :: Lens' Api (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
api_importInfo :: Lens' Api (Maybe [Text]) Source #
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
api_tags :: Lens' Api (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
api_warnings :: Lens' Api (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
api_routeSelectionExpression :: Lens' Api Text Source #
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
api_protocolType :: Lens' Api ProtocolType Source #
The API protocol.
ApiMapping
data ApiMapping Source #
Represents an API mapping.
See: newApiMapping smart constructor.
Constructors
| ApiMapping' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ApiMapping |
Create a value of ApiMapping 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:apiMappingId:ApiMapping', apiMapping_apiMappingId - The API mapping identifier.
$sel:apiMappingKey:ApiMapping', apiMapping_apiMappingKey - The API mapping key.
$sel:stage:ApiMapping', apiMapping_stage - The API stage.
$sel:apiId:ApiMapping', apiMapping_apiId - The API identifier.
apiMapping_apiMappingId :: Lens' ApiMapping (Maybe Text) Source #
The API mapping identifier.
apiMapping_apiMappingKey :: Lens' ApiMapping (Maybe Text) Source #
The API mapping key.
apiMapping_stage :: Lens' ApiMapping Text Source #
The API stage.
apiMapping_apiId :: Lens' ApiMapping Text Source #
The API identifier.
Authorizer
data Authorizer Source #
Represents an authorizer.
See: newAuthorizer smart constructor.
Constructors
| Authorizer' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Authorizer |
Create a value of Authorizer 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:authorizerCredentialsArn:Authorizer', authorizer_authorizerCredentialsArn - Specifies the required credentials as an IAM role for API Gateway to
invoke the authorizer. To specify an IAM role for API Gateway to assume,
use the role's Amazon Resource Name (ARN). To use resource-based
permissions on the Lambda function, don't specify this parameter.
Supported only for REQUEST authorizers.
$sel:authorizerId:Authorizer', authorizer_authorizerId - The authorizer identifier.
$sel:authorizerPayloadFormatVersion:Authorizer', authorizer_authorizerPayloadFormatVersion - Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
$sel:authorizerType:Authorizer', authorizer_authorizerType - The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
$sel:authorizerUri:Authorizer', authorizer_authorizerUri - The authorizer's Uniform Resource Identifier (URI). For REQUEST
authorizers, this must be a well-formed Lambda function URI, for
example,
arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.
In general, the URI has this form:
arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region}
is the same as the region hosting the Lambda function, path indicates
that the remaining substring in the URI should be treated as the path to
the resource, including the initial /. For Lambda functions, this is
usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
Supported only for REQUEST authorizers.
$sel:enableSimpleResponses:Authorizer', authorizer_enableSimpleResponses - Specifies whether a Lambda authorizer returns a response in a simple
format. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more,
see
Working with AWS Lambda authorizers for HTTP APIs
$sel:identitySource:Authorizer', authorizer_identitySource - The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - The validation expression does not apply to the REQUEST authorizer.
$sel:jwtConfiguration:Authorizer', authorizer_jwtConfiguration - Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
$sel:name:Authorizer', authorizer_name - The name of the authorizer.
authorizer_authorizerCredentialsArn :: Lens' Authorizer (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
authorizer_authorizerId :: Lens' Authorizer (Maybe Text) Source #
The authorizer identifier.
authorizer_authorizerPayloadFormatVersion :: Lens' Authorizer (Maybe Text) Source #
Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Natural) Source #
The time to live (TTL) for cached authorizer results, in seconds. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway caches authorizer responses. The maximum value is 3600, or 1 hour. Supported only for HTTP API Lambda authorizers.
authorizer_authorizerType :: Lens' Authorizer (Maybe AuthorizerType) Source #
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #
The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.
authorizer_enableSimpleResponses :: Lens' Authorizer (Maybe Bool) Source #
Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs
authorizer_identitySource :: Lens' Authorizer (Maybe [Text]) Source #
The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, not null, and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function. Otherwise, it returns a 401 Unauthorized response without calling the Lambda function. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #
The validation expression does not apply to the REQUEST authorizer.
authorizer_jwtConfiguration :: Lens' Authorizer (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
authorizer_name :: Lens' Authorizer Text Source #
The name of the authorizer.
Cors
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
See: newCors smart constructor.
Constructors
| Cors' | |
Fields
| |
Instances
Create a value of Cors 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:allowCredentials:Cors', cors_allowCredentials - Specifies whether credentials are included in the CORS request.
Supported only for HTTP APIs.
$sel:allowHeaders:Cors', cors_allowHeaders - Represents a collection of allowed headers. Supported only for HTTP
APIs.
$sel:allowMethods:Cors', cors_allowMethods - Represents a collection of allowed HTTP methods. Supported only for HTTP
APIs.
$sel:allowOrigins:Cors', cors_allowOrigins - Represents a collection of allowed origins. Supported only for HTTP
APIs.
$sel:exposeHeaders:Cors', cors_exposeHeaders - Represents a collection of exposed headers. Supported only for HTTP
APIs.
$sel:maxAge:Cors', cors_maxAge - The number of seconds that the browser should cache preflight request
results. Supported only for HTTP APIs.
cors_allowCredentials :: Lens' Cors (Maybe Bool) Source #
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
cors_allowHeaders :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed headers. Supported only for HTTP APIs.
cors_allowMethods :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
cors_allowOrigins :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed origins. Supported only for HTTP APIs.
cors_exposeHeaders :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of exposed headers. Supported only for HTTP APIs.
cors_maxAge :: Lens' Cors (Maybe Int) Source #
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
Deployment
data Deployment Source #
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
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:autoDeployed:Deployment', deployment_autoDeployed - Specifies whether a deployment was automatically released.
$sel:createdDate:Deployment', deployment_createdDate - The date and time when the Deployment resource was created.
$sel:deploymentId:Deployment', deployment_deploymentId - The identifier for the deployment.
$sel:deploymentStatus:Deployment', deployment_deploymentStatus - The status of the deployment: PENDING, FAILED, or SUCCEEDED.
$sel:deploymentStatusMessage:Deployment', deployment_deploymentStatusMessage - May contain additional feedback on the status of an API deployment.
$sel:description:Deployment', deployment_description - The description for the deployment.
deployment_autoDeployed :: Lens' Deployment (Maybe Bool) Source #
Specifies whether a deployment was automatically released.
deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time when the Deployment resource was created.
deployment_deploymentId :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment.
deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus) Source #
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deployment_deploymentStatusMessage :: Lens' Deployment (Maybe Text) Source #
May contain additional feedback on the status of an API deployment.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment.
DomainName
data DomainName Source #
Represents a domain name.
See: newDomainName smart constructor.
Constructors
| DomainName' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> DomainName |
Create a value of DomainName 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:apiMappingSelectionExpression:DomainName', domainName_apiMappingSelectionExpression - The API mapping selection expression.
$sel:domainNameConfigurations:DomainName', domainName_domainNameConfigurations - The domain name configurations.
$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name.
$sel:tags:DomainName', domainName_tags - The collection of tags associated with a domain name.
$sel:domainName:DomainName', domainName_domainName - The name of the DomainName resource.
domainName_apiMappingSelectionExpression :: Lens' DomainName (Maybe Text) Source #
The API mapping selection expression.
domainName_domainNameConfigurations :: Lens' DomainName (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name.
domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
domainName_domainName :: Lens' DomainName Text Source #
The name of the DomainName resource.
DomainNameConfiguration
data DomainNameConfiguration Source #
The domain name configuration.
See: newDomainNameConfiguration smart constructor.
Constructors
| DomainNameConfiguration' | |
Fields
| |
Instances
newDomainNameConfiguration :: DomainNameConfiguration Source #
Create a value of DomainNameConfiguration 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:apiGatewayDomainName:DomainNameConfiguration', domainNameConfiguration_apiGatewayDomainName - A domain name for the API.
$sel:certificateArn:DomainNameConfiguration', domainNameConfiguration_certificateArn - An AWS-managed certificate that will be used by the edge-optimized
endpoint for this domain name. AWS Certificate Manager is the only
supported source.
$sel:certificateName:DomainNameConfiguration', domainNameConfiguration_certificateName - The user-friendly name of the certificate that will be used by the
edge-optimized endpoint for this domain name.
$sel:certificateUploadDate:DomainNameConfiguration', domainNameConfiguration_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized
endpoint for this domain name was uploaded.
$sel:domainNameStatus:DomainNameConfiguration', domainNameConfiguration_domainNameStatus - The status of the domain name migration. The valid values are AVAILABLE,
UPDATING, PENDING_CERTIFICATE_REIMPORT, and
PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain
cannot be modified further until the existing operation is complete. If
it is AVAILABLE, the domain can be updated.
$sel:domainNameStatusMessage:DomainNameConfiguration', domainNameConfiguration_domainNameStatusMessage - An optional text message containing detailed information about status of
the domain name migration.
$sel:endpointType:DomainNameConfiguration', domainNameConfiguration_endpointType - The endpoint type.
$sel:hostedZoneId:DomainNameConfiguration', domainNameConfiguration_hostedZoneId - The Amazon Route 53 Hosted Zone ID of the endpoint.
$sel:ownershipVerificationCertificateArn:DomainNameConfiguration', domainNameConfiguration_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of
your custom domain. Only required when configuring mutual TLS and using
an ACM imported or private CA certificate ARN as the
regionalCertificateArn
$sel:securityPolicy:DomainNameConfiguration', domainNameConfiguration_securityPolicy - The Transport Layer Security (TLS) version of the security policy for
this domain name. The valid values are TLS_1_0 and TLS_1_2.
domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text) Source #
A domain name for the API.
domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
An AWS-managed certificate that will be used by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text) Source #
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime) Source #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe DomainNameStatus) Source #
The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.
domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text) Source #
An optional text message containing detailed information about status of the domain name migration.
domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType) Source #
The endpoint type.
domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text) Source #
The Amazon Route 53 Hosted Zone ID of the endpoint.
domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn
domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe SecurityPolicy) Source #
The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
Integration
data Integration Source #
Represents an integration.
See: newIntegration smart constructor.
Constructors
| Integration' | |
Fields
| |
Instances
newIntegration :: Integration Source #
Create a value of Integration 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:apiGatewayManaged:Integration', integration_apiGatewayManaged - Specifies whether an integration is managed by API Gateway. If you
created an API using using quick create, the resulting integration is
managed by API Gateway. You can update a managed integration, but you
can't delete it.
$sel:connectionId:Integration', integration_connectionId - The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
$sel:connectionType:Integration', integration_connectionType - The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
$sel:contentHandlingStrategy:Integration', integration_contentHandlingStrategy - Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
$sel:credentialsArn:Integration', integration_credentialsArn - Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
API Gateway to assume, use the role's Amazon Resource Name (ARN). To
require that the caller's identity be passed through from the request,
specify the string arn:aws:iam::*:user/*. To use resource-based
permissions on supported AWS services, specify null.
$sel:description:Integration', integration_description - Represents the description of an integration.
$sel:integrationId:Integration', integration_integrationId - Represents the identifier of an integration.
$sel:integrationMethod:Integration', integration_integrationMethod - Specifies the integration's HTTP method type.
$sel:integrationResponseSelectionExpression:Integration', integration_integrationResponseSelectionExpression - The integration response selection expression for the integration.
Supported only for WebSocket APIs. See
Integration Response Selection Expressions.
$sel:integrationSubtype:Integration', integration_integrationSubtype - Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
$sel:integrationType:Integration', integration_integrationType - The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
$sel:integrationUri:Integration', integration_integrationUri - For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
$sel:passthroughBehavior:Integration', integration_passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
$sel:payloadFormatVersion:Integration', integration_payloadFormatVersion - Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
$sel:requestParameters:Integration', integration_requestParameters - For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. The key is an
integration request parameter name and the associated value is a method
request parameter value or static value that must be enclosed within
single quotes and pre-encoded as required by the backend. The method
request parameter value must match the pattern of
method.request.{location}.{name} , where {location} is querystring,
path, or header; and {name} must be a valid and unique method request
parameter name.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
$sel:requestTemplates:Integration', integration_requestTemplates - Represents a map of Velocity templates that are applied on the request
payload based on the value of the Content-Type header sent by the
client. The content type value is the key in this map, and the template
(as a String) is the value. Supported only for WebSocket APIs.
$sel:responseParameters:Integration', integration_responseParameters - Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
$sel:templateSelectionExpression:Integration', integration_templateSelectionExpression - The template selection expression for the integration. Supported only
for WebSocket APIs.
$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
$sel:tlsConfig:Integration', integration_tlsConfig - The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
integration_apiGatewayManaged :: Lens' Integration (Maybe Bool) Source #
Specifies whether an integration is managed by API Gateway. If you created an API using using quick create, the resulting integration is managed by API Gateway. You can update a managed integration, but you can't delete it.
integration_connectionId :: Lens' Integration (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #
The type of the network connection to the integration endpoint. Specify INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and resources in a VPC. The default value is INTERNET.
integration_contentHandlingStrategy :: Lens' Integration (Maybe ContentHandlingStrategy) Source #
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
integration_credentialsArn :: Lens' Integration (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
integration_description :: Lens' Integration (Maybe Text) Source #
Represents the description of an integration.
integration_integrationId :: Lens' Integration (Maybe Text) Source #
Represents the identifier of an integration.
integration_integrationMethod :: Lens' Integration (Maybe Text) Source #
Specifies the integration's HTTP method type.
integration_integrationResponseSelectionExpression :: Lens' Integration (Maybe Text) Source #
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integration_integrationSubtype :: Lens' Integration (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_integrationType :: Lens' Integration (Maybe IntegrationType) Source #
The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
integration_integrationUri :: Lens' Integration (Maybe Text) Source #
For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
integration_passthroughBehavior :: Lens' Integration (Maybe PassthroughBehavior) Source #
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
integration_payloadFormatVersion :: Lens' Integration (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #
For WebSocket APIs, a key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
integration_responseParameters :: Lens' Integration (Maybe (HashMap Text (HashMap Text Text))) Source #
Supported only for HTTP APIs. You use response parameters to transform the HTTP response from a backend integration before returning the response to clients. Specify a key-value map from a selection key to response parameters. The selection key must be a valid HTTP status code within the range of 200-599. Response parameters are a key-value map. The key must match pattern <action>:<header>.<location> or overwrite.statuscode. The action can be append, overwrite or remove. The value can be a static value, or map to response data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
integration_templateSelectionExpression :: Lens' Integration (Maybe Text) Source #
The template selection expression for the integration. Supported only for WebSocket APIs.
integration_timeoutInMillis :: Lens' Integration (Maybe Natural) Source #
Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is 29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
IntegrationResponse
data IntegrationResponse Source #
Represents an integration response.
See: newIntegrationResponse smart constructor.
Constructors
| IntegrationResponse' | |
Fields
| |
Instances
newIntegrationResponse Source #
Create a value of IntegrationResponse 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:contentHandlingStrategy:IntegrationResponse', integrationResponse_contentHandlingStrategy - Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
$sel:integrationResponseId:IntegrationResponse', integrationResponse_integrationResponseId - The integration response ID.
$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the
method response from the backend. The key is a method response header
parameter name and the mapped value is an integration response header
value, a static value enclosed within a pair of single quotes, or a JSON
expression from the integration response body. The mapping key must
match the pattern of method.response.header.{name}, where name is a
valid and unique header name. The mapped non-static value must match the
pattern of integration.response.header.{name} or
integration.response.body.{JSON-expression}, where name is a valid and
unique response header name and JSON-expression is a valid JSON
expression without the $ prefix.
$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
$sel:templateSelectionExpression:IntegrationResponse', integrationResponse_templateSelectionExpression - The template selection expressions for the integration response.
$sel:integrationResponseKey:IntegrationResponse', integrationResponse_integrationResponseKey - The integration response key.
integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #
Supported only for WebSocket APIs. Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text) Source #
The integration response ID.
integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
A key-value map specifying response parameters that are passed to the method response from the backend. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.
integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
The collection of response templates for the integration response as a string-to-string map of key-value pairs. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text) Source #
The template selection expressions for the integration response.
integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text Source #
The integration response key.
JWTConfiguration
data JWTConfiguration Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
See: newJWTConfiguration smart constructor.
Constructors
| JWTConfiguration' | |
Fields
| |
Instances
newJWTConfiguration :: JWTConfiguration Source #
Create a value of JWTConfiguration 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:audience:JWTConfiguration', jWTConfiguration_audience - A list of the intended recipients of the JWT. A valid JWT must provide
an aud that matches at least one entry in this list. See
RFC 7519. Supported
only for HTTP APIs.
$sel:issuer:JWTConfiguration', jWTConfiguration_issuer - The base domain of the identity provider that issues JSON Web Tokens.
For example, an Amazon Cognito user pool has the following format:
https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required
for the JWT authorizer type. Supported only for HTTP APIs.
jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text]) Source #
A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.
jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text) Source #
The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required for the JWT authorizer type. Supported only for HTTP APIs.
Model
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
See: newModel smart constructor.
Constructors
| Model' | |
Fields
| |
Instances
Create a value of Model 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:contentType:Model', model_contentType - The content-type for the model, for example, "application/json".
$sel:description:Model', model_description - The description of the model.
$sel:modelId:Model', model_modelId - The model identifier.
$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
$sel:name:Model', model_name - The name of the model. Must be alphanumeric.
model_contentType :: Lens' Model (Maybe Text) Source #
The content-type for the model, for example, "application/json".
model_schema :: Lens' Model (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
MutualTlsAuthentication
data MutualTlsAuthentication Source #
See: newMutualTlsAuthentication smart constructor.
Constructors
| MutualTlsAuthentication' | |
Fields
| |
Instances
newMutualTlsAuthentication :: MutualTlsAuthentication Source #
Create a value of MutualTlsAuthentication 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:truststoreUri:MutualTlsAuthentication', mutualTlsAuthentication_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example, s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
$sel:truststoreVersion:MutualTlsAuthentication', mutualTlsAuthentication_truststoreVersion - The version of the S3 object that contains your truststore. To specify a
version, you must have versioning enabled for the S3 bucket.
$sel:truststoreWarnings:MutualTlsAuthentication', mutualTlsAuthentication_truststoreWarnings - A list of warnings that API Gateway returns while processing your
truststore. Invalid certificates produce warnings. Mutual TLS is still
enabled, but some clients might not be able to access your API. To
resolve warnings, upload a new truststore to S3, and then update you
domain name to use the new version.
mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text]) Source #
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
MutualTlsAuthenticationInput
data MutualTlsAuthenticationInput Source #
See: newMutualTlsAuthenticationInput smart constructor.
Constructors
| MutualTlsAuthenticationInput' | |
Fields
| |
Instances
newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput Source #
Create a value of MutualTlsAuthenticationInput 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:truststoreUri:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example, s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
$sel:truststoreVersion:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreVersion - The version of the S3 object that contains your truststore. To specify a
version, you must have versioning enabled for the S3 bucket.
mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
ParameterConstraints
data ParameterConstraints Source #
Validation constraints imposed on parameters of a request (path, query string, headers).
See: newParameterConstraints smart constructor.
Constructors
| ParameterConstraints' | |
Instances
newParameterConstraints :: ParameterConstraints Source #
Create a value of ParameterConstraints 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:required:ParameterConstraints', parameterConstraints_required - Whether or not the parameter is required.
parameterConstraints_required :: Lens' ParameterConstraints (Maybe Bool) Source #
Whether or not the parameter is required.
Route
Represents a route.
See: newRoute smart constructor.
Constructors
| Route' | |
Fields
| |
Instances
Create a value of Route 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:apiGatewayManaged:Route', route_apiGatewayManaged - Specifies whether a route is managed by API Gateway. If you created an
API using quick create, the $default route is managed by API Gateway.
You can't modify the $default route key.
$sel:apiKeyRequired:Route', route_apiKeyRequired - Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
$sel:authorizationScopes:Route', route_authorizationScopes - A list of authorization scopes configured on a route. The scopes are
used with a JWT authorizer to authorize the method invocation. The
authorization works by matching the route scopes against the scopes
parsed from the access token in the incoming request. The method
invocation is authorized if any route scope matches a claimed scope in
the access token. Otherwise, the invocation is not authorized. When the
route scope is configured, the client must provide an access token
instead of an identity token for authorization purposes.
$sel:authorizationType:Route', route_authorizationType - The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
$sel:authorizerId:Route', route_authorizerId - The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
$sel:modelSelectionExpression:Route', route_modelSelectionExpression - The model selection expression for the route. Supported only for
WebSocket APIs.
$sel:operationName:Route', route_operationName - The operation name for the route.
$sel:requestModels:Route', route_requestModels - The request models for the route. Supported only for WebSocket APIs.
$sel:requestParameters:Route', route_requestParameters - The request parameters for the route. Supported only for WebSocket APIs.
$sel:routeId:Route', route_routeId - The route ID.
$sel:routeResponseSelectionExpression:Route', route_routeResponseSelectionExpression - The route response selection expression for the route. Supported only
for WebSocket APIs.
$sel:target:Route', route_target - The target for the route.
$sel:routeKey:Route', route_routeKey - The route key for the route.
route_apiGatewayManaged :: Lens' Route (Maybe Bool) Source #
Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
route_apiKeyRequired :: Lens' Route (Maybe Bool) Source #
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
route_authorizationScopes :: Lens' Route (Maybe [Text]) Source #
A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
route_authorizationType :: Lens' Route (Maybe AuthorizationType) Source #
The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
route_authorizerId :: Lens' Route (Maybe Text) Source #
The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.
route_modelSelectionExpression :: Lens' Route (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
route_requestModels :: Lens' Route (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
route_routeResponseSelectionExpression :: Lens' Route (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
RouteResponse
data RouteResponse Source #
Represents a route response.
See: newRouteResponse smart constructor.
Constructors
| RouteResponse' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> RouteResponse |
Create a value of RouteResponse 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:modelSelectionExpression:RouteResponse', routeResponse_modelSelectionExpression - Represents the model selection expression of a route response. Supported
only for WebSocket APIs.
$sel:responseModels:RouteResponse', routeResponse_responseModels - Represents the response models of a route response.
$sel:responseParameters:RouteResponse', routeResponse_responseParameters - Represents the response parameters of a route response.
$sel:routeResponseId:RouteResponse', routeResponse_routeResponseId - Represents the identifier of a route response.
$sel:routeResponseKey:RouteResponse', routeResponse_routeResponseKey - Represents the route response key of a route response.
routeResponse_modelSelectionExpression :: Lens' RouteResponse (Maybe Text) Source #
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
routeResponse_responseModels :: Lens' RouteResponse (Maybe (HashMap Text Text)) Source #
Represents the response models of a route response.
routeResponse_responseParameters :: Lens' RouteResponse (Maybe (HashMap Text ParameterConstraints)) Source #
Represents the response parameters of a route response.
routeResponse_routeResponseId :: Lens' RouteResponse (Maybe Text) Source #
Represents the identifier of a route response.
routeResponse_routeResponseKey :: Lens' RouteResponse Text Source #
Represents the route response key of a route response.
RouteSettings
data RouteSettings Source #
Represents a collection of route settings.
See: newRouteSettings smart constructor.
Constructors
| RouteSettings' | |
Fields
| |
Instances
newRouteSettings :: RouteSettings Source #
Create a value of RouteSettings 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:dataTraceEnabled:RouteSettings', routeSettings_dataTraceEnabled - Specifies whether (true) or not (false) data trace logging is enabled
for this route. This property affects the log entries pushed to Amazon
CloudWatch Logs. Supported only for WebSocket APIs.
$sel:detailedMetricsEnabled:RouteSettings', routeSettings_detailedMetricsEnabled - Specifies whether detailed metrics are enabled.
$sel:loggingLevel:RouteSettings', routeSettings_loggingLevel - Specifies the logging level for this route: INFO, ERROR, or OFF. This
property affects the log entries pushed to Amazon CloudWatch Logs.
Supported only for WebSocket APIs.
$sel:throttlingBurstLimit:RouteSettings', routeSettings_throttlingBurstLimit - Specifies the throttling burst limit.
$sel:throttlingRateLimit:RouteSettings', routeSettings_throttlingRateLimit - Specifies the throttling rate limit.
routeSettings_dataTraceEnabled :: Lens' RouteSettings (Maybe Bool) Source #
Specifies whether (true) or not (false) data trace logging is enabled for this route. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
routeSettings_detailedMetricsEnabled :: Lens' RouteSettings (Maybe Bool) Source #
Specifies whether detailed metrics are enabled.
routeSettings_loggingLevel :: Lens' RouteSettings (Maybe LoggingLevel) Source #
Specifies the logging level for this route: INFO, ERROR, or OFF. This property affects the log entries pushed to Amazon CloudWatch Logs. Supported only for WebSocket APIs.
routeSettings_throttlingBurstLimit :: Lens' RouteSettings (Maybe Int) Source #
Specifies the throttling burst limit.
routeSettings_throttlingRateLimit :: Lens' RouteSettings (Maybe Double) Source #
Specifies the throttling rate limit.
Stage
Represents an API stage.
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:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.
$sel:apiGatewayManaged:Stage', stage_apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an
API using quick create, the $default stage is managed by API Gateway.
You can't modify the $default stage.
$sel:autoDeploy:Stage', stage_autoDeploy - Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.
$sel:defaultRouteSettings:Stage', stage_defaultRouteSettings - Default route settings for the stage.
$sel:deploymentId:Stage', stage_deploymentId - The identifier of the Deployment that the Stage is associated with.
Can't be updated if autoDeploy is enabled.
$sel:description:Stage', stage_description - The description of the stage.
$sel:lastDeploymentStatusMessage:Stage', stage_lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only
for stages with autoDeploy enabled.
$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage was last updated.
$sel:routeSettings:Stage', stage_routeSettings - Route settings for the stage, by routeKey.
$sel:stageVariables:Stage', stage_stageVariables - 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:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given
resource.
$sel:stageName:Stage', stage_stageName - The name of the stage.
stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
stage_apiGatewayManaged :: Lens' Stage (Maybe Bool) Source #
Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
stage_autoDeploy :: Lens' Stage (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings) Source #
Default route settings for the stage.
stage_deploymentId :: Lens' Stage (Maybe Text) Source #
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text) Source #
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #
The timestamp when the stage was last updated.
stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
stage_stageVariables :: 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_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
TlsConfig
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
See: newTlsConfig smart constructor.
Constructors
| TlsConfig' | |
Fields
| |
Instances
| FromJSON TlsConfig Source # | |
| Generic TlsConfig Source # | |
| Read TlsConfig Source # | |
| Show TlsConfig Source # | |
| NFData TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig | |
| Eq TlsConfig Source # | |
| Hashable TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig | |
| type Rep TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig type Rep TlsConfig = D1 ('MetaData "TlsConfig" "Amazonka.ApiGatewayV2.Types.TlsConfig" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "TlsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverNameToVerify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newTlsConfig :: TlsConfig Source #
Create a value of TlsConfig 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:serverNameToVerify:TlsConfig', tlsConfig_serverNameToVerify - If you specify a server name, API Gateway uses it to verify the hostname
on the integration's certificate. The server name is also included in
the TLS handshake to support Server Name Indication (SNI) or virtual
hosting.
tlsConfig_serverNameToVerify :: Lens' TlsConfig (Maybe Text) Source #
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
TlsConfigInput
data TlsConfigInput Source #
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
See: newTlsConfigInput smart constructor.
Constructors
| TlsConfigInput' | |
Fields
| |
Instances
newTlsConfigInput :: TlsConfigInput Source #
Create a value of TlsConfigInput 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:serverNameToVerify:TlsConfigInput', tlsConfigInput_serverNameToVerify - If you specify a server name, API Gateway uses it to verify the hostname
on the integration's certificate. The server name is also included in
the TLS handshake to support Server Name Indication (SNI) or virtual
hosting.
tlsConfigInput_serverNameToVerify :: Lens' TlsConfigInput (Maybe Text) Source #
If you specify a server name, API Gateway uses it to verify the hostname on the integration's certificate. The server name is also included in the TLS handshake to support Server Name Indication (SNI) or virtual hosting.
VpcLink
Represents a VPC link.
See: newVpcLink smart constructor.
Constructors
| VpcLink' | |
Fields
| |
Instances
Create a value of VpcLink 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:createdDate:VpcLink', vpcLink_createdDate - The timestamp when the VPC link was created.
$sel:tags:VpcLink', vpcLink_tags - Tags for the VPC link.
$sel:vpcLinkStatus:VpcLink', vpcLink_vpcLinkStatus - The status of the VPC link.
$sel:vpcLinkStatusMessage:VpcLink', vpcLink_vpcLinkStatusMessage - A message summarizing the cause of the status of the VPC link.
$sel:vpcLinkVersion:VpcLink', vpcLink_vpcLinkVersion - The version of the VPC link.
$sel:vpcLinkId:VpcLink', vpcLink_vpcLinkId - The ID of the VPC link.
$sel:securityGroupIds:VpcLink', vpcLink_securityGroupIds - A list of security group IDs for the VPC link.
$sel:subnetIds:VpcLink', vpcLink_subnetIds - A list of subnet IDs to include in the VPC link.
$sel:name:VpcLink', vpcLink_name - The name of the VPC link.
vpcLink_createdDate :: Lens' VpcLink (Maybe UTCTime) Source #
The timestamp when the VPC link was created.
vpcLink_vpcLinkStatus :: Lens' VpcLink (Maybe VpcLinkStatus) Source #
The status of the VPC link.
vpcLink_vpcLinkStatusMessage :: Lens' VpcLink (Maybe Text) Source #
A message summarizing the cause of the status of the VPC link.
vpcLink_vpcLinkVersion :: Lens' VpcLink (Maybe VpcLinkVersion) Source #
The version of the VPC link.