String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
String 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.
String authorizerId
The authorizer identifier.
String 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.
Integer 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.
String 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).
String 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:
Boolean 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
List<E> 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.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
Boolean allowCredentials
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
List<E> allowHeaders
Represents a collection of allowed headers. Supported only for HTTP APIs.
List<E> allowMethods
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
List<E> allowOrigins
Represents a collection of allowed origins. Supported only for HTTP APIs.
List<E> exposeHeaders
Represents a collection of exposed headers. Supported only for HTTP APIs.
Integer maxAge
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
String credentialsArn
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
String name
The name of the API.
String protocolType
The API protocol.
String routeKey
This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
String 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.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String target
This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
String version
A version identifier for the API.
String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
String apiId
The API identifier.
String 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.
String 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.
Integer 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.
String 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).
String 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:
Boolean enableSimpleResponses
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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
List<E> 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.
String identityValidationExpression
This parameter is not used.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
String 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.
String authorizerId
The authorizer identifier.
String 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.
Integer 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.
String 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).
String 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:
Boolean 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
List<E> 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.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
Boolean autoDeployed
Specifies whether a deployment was automatically released.
Date createdDate
The date and time when the Deployment resource was created.
String deploymentId
The identifier for the deployment.
String deploymentStatus
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
String deploymentStatusMessage
May contain additional feedback on the status of an API deployment.
String description
The description for the deployment.
String domainName
The domain name.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthenticationInput mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
Map<K,V> tags
The collection of tags associated with a domain name.
String apiMappingSelectionExpression
The API mapping selection expression.
String domainName
The name of the DomainName resource.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthentication mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
Map<K,V> tags
The collection of tags associated with a domain name.
String apiId
The API identifier.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
The description of the integration.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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. For HTTP API private integrations, use an 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration.
Integer 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.
TlsConfigInput 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.
String apiId
The API identifier.
String contentHandlingStrategy
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.
String integrationId
The integration ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration response. Supported only for WebSocket APIs.
String 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.
String integrationResponseId
The integration response ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expressions for the integration response.
Boolean 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.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
Represents the description of an integration.
String integrationId
Represents the identifier of an integration.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationResponseSelectionExpression
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations, 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration. Supported only for WebSocket APIs.
Integer 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.
TlsConfig 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.
String apiId
The API identifier.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String name
The name of the model. Must be alphanumeric.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String modelId
The model identifier.
String name
The name of the model. Must be alphanumeric.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String apiId
The API identifier.
Boolean apiKeyRequired
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
List<E> authorizationScopes
The authorization scopes supported by this route.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
String apiId
The API identifier.
String modelSelectionExpression
The model selection expression for the route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
The response models for the route response.
Map<K,V> responseParameters
The route response parameters.
String routeId
The route ID.
String routeResponseKey
The route response key.
String modelSelectionExpression
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
Represents the response models of a route response.
Map<K,V> responseParameters
Represents the response parameters of a route response.
String routeResponseId
Represents the identifier of a route response.
String routeResponseKey
Represents the route response key of a route response.
Boolean 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.
Boolean apiKeyRequired
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
List<E> 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.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String apiId
The API identifier.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
RouteSettings defaultRouteSettings
The default route settings for the stage.
String deploymentId
The deployment identifier of the API stage.
String description
The description for the API stage.
Map<K,V> routeSettings
Route settings for the stage, by routeKey.
String stageName
The name of the stage.
Map<K,V> stageVariables
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
Boolean 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.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Date createdDate
The timestamp when the stage was created.
RouteSettings defaultRouteSettings
Default route settings for the stage.
String deploymentId
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
String description
The description of the stage.
String lastDeploymentStatusMessage
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage, by routeKey.
String stageName
The name of the stage.
Map<K,V> 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-._~:/?#&=,]+.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the VPC link was created.
String name
The name of the VPC link.
List<E> securityGroupIds
A list of security group IDs for the VPC link.
List<E> subnetIds
A list of subnet IDs to include in the VPC link.
Map<K,V> tags
Tags for the VPC link.
String vpcLinkId
The ID of the VPC link.
String vpcLinkStatus
The status of the VPC link.
String vpcLinkStatusMessage
A message summarizing the cause of the status of the VPC link.
String vpcLinkVersion
The version of the VPC link.
String apiId
The API identifier.
String apiId
The API identifier.
String domainName
The domain name.
String vpcLinkId
The ID of the VPC link.
Boolean autoDeployed
Specifies whether a deployment was automatically released.
Date createdDate
The date and time when the Deployment resource was created.
String deploymentId
The identifier for the deployment.
String deploymentStatus
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
String deploymentStatusMessage
May contain additional feedback on the status of an API deployment.
String description
The description for the deployment.
String apiMappingSelectionExpression
The API mapping selection expression.
String domainName
The name of the DomainName resource.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthentication mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
Map<K,V> tags
The collection of tags associated with a domain name.
String apiGatewayDomainName
A domain name for the API.
String 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.
String certificateName
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
Date certificateUploadDate
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
String 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.
String domainNameStatusMessage
An optional text message containing detailed information about status of the domain name migration.
String endpointType
The endpoint type.
String hostedZoneId
The Amazon Route 53 Hosted Zone ID of the endpoint.
String 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.
String 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
String apiId
The API identifier.
String exportVersion
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
Boolean includeExtensions
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
String outputType
The output type of the exported definition file. Valid values are JSON and YAML.
String specification
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
String stageName
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
ByteBuffer body
String apiId
The API identifier.
String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
String 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.
String authorizerId
The authorizer identifier.
String 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.
Integer 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.
String 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).
String 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:
Boolean 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
List<E> 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.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
Boolean autoDeployed
Specifies whether a deployment was automatically released.
Date createdDate
The date and time when the Deployment resource was created.
String deploymentId
The identifier for the deployment.
String deploymentStatus
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
String deploymentStatusMessage
May contain additional feedback on the status of an API deployment.
String description
The description for the deployment.
String domainName
The domain name.
String apiMappingSelectionExpression
The API mapping selection expression.
String domainName
The name of the DomainName resource.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthentication mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
Map<K,V> tags
The collection of tags associated with a domain name.
String 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.
String integrationResponseId
The integration response ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expressions for the integration response.
String apiId
The API identifier.
String integrationId
The integration ID.
String maxResults
The maximum number of elements to be returned for this resource.
String nextToken
The next page of elements from this collection. Not valid for the last element of the collection.
Boolean 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.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
Represents the description of an integration.
String integrationId
Represents the identifier of an integration.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationResponseSelectionExpression
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations, 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration. Supported only for WebSocket APIs.
Integer 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.
TlsConfig 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.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String modelId
The model identifier.
String name
The name of the model. Must be alphanumeric.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String value
The template value.
String modelSelectionExpression
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
Represents the response models of a route response.
Map<K,V> responseParameters
Represents the response parameters of a route response.
String routeResponseId
Represents the identifier of a route response.
String routeResponseKey
Represents the route response key of a route response.
Boolean 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.
Boolean apiKeyRequired
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
List<E> 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.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
Boolean 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.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Date createdDate
The timestamp when the stage was created.
RouteSettings defaultRouteSettings
Default route settings for the stage.
String deploymentId
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
String description
The description of the stage.
String lastDeploymentStatusMessage
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage, by routeKey.
String stageName
The name of the stage.
Map<K,V> 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-._~:/?#&=,]+.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String resourceArn
The resource ARN for the tag.
String vpcLinkId
The ID of the VPC link.
Date createdDate
The timestamp when the VPC link was created.
String name
The name of the VPC link.
List<E> securityGroupIds
A list of security group IDs for the VPC link.
List<E> subnetIds
A list of subnet IDs to include in the VPC link.
Map<K,V> tags
Tags for the VPC link.
String vpcLinkId
The ID of the VPC link.
String vpcLinkStatus
The status of the VPC link.
String vpcLinkStatusMessage
A message summarizing the cause of the status of the VPC link.
String vpcLinkVersion
The version of the VPC link.
String basepath
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
String body
The OpenAPI definition. Supported only for HTTP APIs.
Boolean failOnWarnings
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
Boolean 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.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
Represents the description of an integration.
String integrationId
Represents the identifier of an integration.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationResponseSelectionExpression
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations, 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration. Supported only for WebSocket APIs.
Integer 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.
TlsConfig 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.
String 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.
String integrationResponseId
The integration response ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expressions for the integration response.
List<E> 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.
String 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.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String modelId
The model identifier.
String name
The name of the model. Must be alphanumeric.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String truststoreUri
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example,
s3://
String truststoreVersion
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
List<E> 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.
String truststoreUri
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example,
s3://
String truststoreVersion
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
String resourceType
The resource type.
Boolean required
Whether or not the parameter is required.
String apiId
The API identifier.
String basepath
Specifies how to interpret the base path of the API during import. Valid values are ignore, prepend, and split. The default value is ignore. To learn more, see Set the OpenAPI basePath Property. Supported only for HTTP APIs.
String body
The OpenAPI definition. Supported only for HTTP APIs.
Boolean failOnWarnings
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
Boolean 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.
Boolean apiKeyRequired
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
List<E> 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.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
String modelSelectionExpression
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
Represents the response models of a route response.
Map<K,V> responseParameters
Represents the response parameters of a route response.
String routeResponseId
Represents the identifier of a route response.
String routeResponseKey
Represents the route response key of a route response.
Boolean 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.
Boolean detailedMetricsEnabled
Specifies whether detailed metrics are enabled.
String 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.
Integer throttlingBurstLimit
Specifies the throttling burst limit.
Double throttlingRateLimit
Specifies the throttling rate limit.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
Boolean 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.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Date createdDate
The timestamp when the stage was created.
RouteSettings defaultRouteSettings
Default route settings for the stage.
String deploymentId
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
String description
The description of the stage.
String lastDeploymentStatusMessage
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage, by routeKey.
String stageName
The name of the stage.
Map<K,V> 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-._~:/?#&=,]+.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
String 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.
String 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.
String limitType
The limit type.
String apiId
The API identifier.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
String credentialsArn
This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, 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 arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
String name
The name of the API.
String routeKey
This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.
String 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.
String target
This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.
String version
A version identifier for the API.
String 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.
Boolean 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
Cors corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
Date createdDate
The timestamp when the API was created.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
Boolean 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.
List<E> 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.
String name
The name of the API.
String protocolType
The API protocol.
String 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.
Map<K,V> tags
A collection of tags associated with the API.
String version
A version identifier for the API.
List<E> warnings
The warning messages reported when failonwarnings is turned on during API import.
String apiId
The API identifier.
String 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.
String authorizerId
The authorizer identifier.
String 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.
Integer 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.
String 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).
String 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:
Boolean enableSimpleResponses
Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. 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
List<E> 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.
String identityValidationExpression
This parameter is not used.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
String 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.
String authorizerId
The authorizer identifier.
String 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.
Integer 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.
String 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).
String 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:
Boolean 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
List<E> 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.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
JWTConfiguration jwtConfiguration
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
String name
The name of the authorizer.
Boolean autoDeployed
Specifies whether a deployment was automatically released.
Date createdDate
The date and time when the Deployment resource was created.
String deploymentId
The identifier for the deployment.
String deploymentStatus
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
String deploymentStatusMessage
May contain additional feedback on the status of an API deployment.
String description
The description for the deployment.
String domainName
The domain name.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthenticationInput mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
String apiMappingSelectionExpression
The API mapping selection expression.
String domainName
The name of the DomainName resource.
List<E> domainNameConfigurations
The domain name configurations.
MutualTlsAuthentication mutualTlsAuthentication
The mutual TLS authentication configuration for a custom domain name.
Map<K,V> tags
The collection of tags associated with a domain name.
String apiId
The API identifier.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
The description of the integration
String integrationId
The integration ID.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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. For HTTP API private integrations, use an 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration.
Integer 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.
TlsConfigInput 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.
String apiId
The API identifier.
String 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.
String integrationId
The integration ID.
String integrationResponseId
The integration response ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration response. Supported only for WebSocket APIs.
String 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.
String integrationResponseId
The integration response ID.
String integrationResponseKey
The integration response key.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expressions for the integration response.
Boolean 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.
String connectionId
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
String 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.
String 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.
String 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.
String description
Represents the description of an integration.
String integrationId
Represents the identifier of an integration.
String integrationMethod
Specifies the integration's HTTP method type.
String integrationResponseSelectionExpression
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
String integrationSubtype
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
String 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.
String 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.
String 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.
String payloadFormatVersion
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
Map<K,V> 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.
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 integrations, 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.
Map<K,V> 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.
Map<K,V> 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.
String templateSelectionExpression
The template selection expression for the integration. Supported only for WebSocket APIs.
Integer 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.
TlsConfig 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.
String apiId
The API identifier.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String modelId
The model ID.
String name
The name of the model.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String contentType
The content-type for the model, for example, "application/json".
String description
The description of the model.
String modelId
The model identifier.
String name
The name of the model. Must be alphanumeric.
String schema
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
String apiId
The API identifier.
Boolean apiKeyRequired
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
List<E> authorizationScopes
The authorization scopes supported by this route.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
String apiId
The API identifier.
String modelSelectionExpression
The model selection expression for the route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
The response models for the route response.
Map<K,V> responseParameters
The route response parameters.
String routeId
The route ID.
String routeResponseId
The route response ID.
String routeResponseKey
The route response key.
String modelSelectionExpression
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
Map<K,V> responseModels
Represents the response models of a route response.
Map<K,V> responseParameters
Represents the response parameters of a route response.
String routeResponseId
Represents the identifier of a route response.
String routeResponseKey
Represents the route response key of a route response.
Boolean 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.
Boolean apiKeyRequired
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
List<E> 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.
String 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.
String 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.
String modelSelectionExpression
The model selection expression for the route. Supported only for WebSocket APIs.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route. Supported only for WebSocket APIs.
Map<K,V> requestParameters
The request parameters for the route. Supported only for WebSocket APIs.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route. Supported only for WebSocket APIs.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String apiId
The API identifier.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage.
RouteSettings defaultRouteSettings
The default route settings for the stage.
String deploymentId
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
String description
The description for the API stage.
Map<K,V> routeSettings
Route settings for the stage.
String stageName
The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
Map<K,V> stageVariables
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
Boolean 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.
Boolean autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
String clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
Date createdDate
The timestamp when the stage was created.
RouteSettings defaultRouteSettings
Default route settings for the stage.
String deploymentId
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
String description
The description of the stage.
String lastDeploymentStatusMessage
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage, by routeKey.
String stageName
The name of the stage.
Map<K,V> 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-._~:/?#&=,]+.
Map<K,V> tags
The collection of tags. Each tag element is associated with a given resource.
Date createdDate
The timestamp when the VPC link was created.
String name
The name of the VPC link.
List<E> securityGroupIds
A list of security group IDs for the VPC link.
List<E> subnetIds
A list of subnet IDs to include in the VPC link.
Map<K,V> tags
Tags for the VPC link.
String vpcLinkId
The ID of the VPC link.
String vpcLinkStatus
The status of the VPC link.
String vpcLinkStatusMessage
A message summarizing the cause of the status of the VPC link.
String vpcLinkVersion
The version of the VPC link.
Date createdDate
The timestamp when the VPC link was created.
String name
The name of the VPC link.
List<E> securityGroupIds
A list of security group IDs for the VPC link.
List<E> subnetIds
A list of subnet IDs to include in the VPC link.
Map<K,V> tags
Tags for the VPC link.
String vpcLinkId
The ID of the VPC link.
String vpcLinkStatus
The status of the VPC link.
String vpcLinkStatusMessage
A message summarizing the cause of the status of the VPC link.
String vpcLinkVersion
The version of the VPC link.
Copyright © 2024. All rights reserved.