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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
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.
String name
The name of the API.
String protocolType
The API protocol: Currently only WEBSOCKET is supported.
String routeSelectionExpression
The route selection expression for 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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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, specify null.
String authorizerId
The authorizer identifier.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
String authorizerUri
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment.
String name
The name of the API.
String protocolType
The API protocol: Currently only WEBSOCKET is supported.
String routeSelectionExpression
The route selection expression for the API.
String version
A version identifier for the API.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
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.
String name
The name of the API.
String protocolType
The API protocol: Currently only WEBSOCKET is supported.
String routeSelectionExpression
The route selection expression for 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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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, specify null.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
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: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
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, specify null.
String authorizerId
The authorizer identifier.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
String authorizerUri
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String apiMappingSelectionExpression
The API mapping selection expression.
String domainName
The name of the DomainName resource.
List<E> domainNameConfigurations
The domain name configurations.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String apiId
The API identifier.
String connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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 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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as HTTP custom integration.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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.
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 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 connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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. See Integration Response Selection Expressions.
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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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.
List<E> authorizationScopes
The authorization scopes supported by this route.
String authorizationType
The authorization type for the route. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
String apiId
The API identifier.
String modelSelectionExpression
The model selection expression for the route response.
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.
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 apiKeyRequired
Specifies whether an API key is required for this route.
List<E> authorizationScopes
A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS 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. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String apiId
The API identifier.
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 of the API stage.
String description
The description for the API stage.
Map<K,V> routeSettings
Route settings for the stage.
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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String clientCertificateId
The identifier of a client certificate for a Stage.
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.
String description
The description of the stage.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage.
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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String apiId
The API identifier.
String domainName
The domain name.
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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String apiGatewayDomainName
A domain name for the WebSocket 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 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 domainNameStatus
The status of the domain name migration. The valid values are AVAILABLE and UPDATING. 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 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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
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.
String name
The name of the API.
String protocolType
The API protocol: Currently only WEBSOCKET is supported.
String routeSelectionExpression
The route selection expression for 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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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, specify null.
String authorizerId
The authorizer identifier.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
String authorizerUri
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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 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.
String connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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. See Integration Response Selection Expressions.
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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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.
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 apiKeyRequired
Specifies whether an API key is required for this route.
List<E> authorizationScopes
A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS 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. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String clientCertificateId
The identifier of a client certificate for a Stage.
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.
String description
The description of the stage.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage.
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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String resourceArn
String connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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. See Integration Response Selection Expressions.
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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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 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 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 resourceType
The resource type.
Boolean required
Whether or not the parameter is required.
Boolean apiKeyRequired
Specifies whether an API key is required for this route.
List<E> authorizationScopes
A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS 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. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
String modelSelectionExpression
Represents the model selection expression of a route response.
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.
Boolean detailedMetricsEnabled
Specifies whether detailed metrics are enabled.
String loggingLevel
Specifies the logging level for this route: DEBUG, INFO, or WARN. This property affects the log entries pushed to Amazon CloudWatch Logs.
Integer throttlingBurstLimit
Specifies the throttling burst limit.
Double throttlingRateLimit
Specifies the throttling rate limit.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String clientCertificateId
The identifier of a client certificate for a Stage.
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.
String description
The description of the stage.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage.
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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String limitType
The limit type.
String apiId
The API identifier.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
String description
The description of the API.
Boolean disableSchemaValidation
Avoid validating models when creating a deployment.
String name
The name of the API.
String routeSelectionExpression
The route selection expression for the API.
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.
String apiId
The API ID.
String apiKeySelectionExpression
An API key selection expression. See API Key Selection Expressions.
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.
String name
The name of the API.
String protocolType
The API protocol: Currently only WEBSOCKET is supported.
String routeSelectionExpression
The route selection expression for 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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
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, specify null.
String authorizerId
The authorizer identifier.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it is zero, authorization caching is disabled. If it is greater than zero, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
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: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is $method.request.header.Auth, $method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
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, specify null.
String authorizerId
The authorizer identifier.
Integer authorizerResultTtlInSeconds
The time to live (TTL), in seconds, of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
String authorizerType
The authorizer type. Currently the only valid value is REQUEST, for a Lambda function using incoming request parameters.
String authorizerUri
The authorizer's Uniform Resource Identifier (URI). ForREQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2: {account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.
List<E> identitySource
The identity source for which authorization is requested.
For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header and a Name query string parameters are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, 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. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
String identityValidationExpression
The validation expression does not apply to the REQUEST authorizer.
String name
The name of the authorizer.
List<E> providerArns
For REQUEST authorizer, this is not defined.
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.
Map<K,V> tags
The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
String apiId
The API identifier.
String connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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 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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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 integrationResponseId
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.
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 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 connectionId
The connection ID.
String connectionType
The type of the network connection to the integration endpoint. Currently the only valid value is INTERNET, for connections through the public routable internet.
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 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. See Integration Response Selection Expressions.
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.
AWS_PROXY: for integrating the route or method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as 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.
HTTP_PROXY: for integrating 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.
String integrationUri
For a Lambda proxy integration, this is the URI of the Lambda function.
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.
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.
Map<K,V> requestParameters
A key-value map specifying request parameters that are passed from the method request to the backend. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the backend. The method request parameter value must match the pattern of method.request.{location}.{name} , where {location} is querystring, path, or header; and {name} must be a valid and unique method request parameter name.
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.
String templateSelectionExpression
The template selection expression for the integration.
Integer timeoutInMillis
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
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.
List<E> authorizationScopes
The authorization scopes supported by this route.
String authorizationType
The authorization type for the route. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
String apiId
The API identifier.
String modelSelectionExpression
The model selection expression for the route response.
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.
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 apiKeyRequired
Specifies whether an API key is required for this route.
List<E> authorizationScopes
A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS 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. Valid values are NONE for open access, 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, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.
String modelSelectionExpression
The model selection expression for the route.
String operationName
The operation name for the route.
Map<K,V> requestModels
The request models for the route.
Map<K,V> requestParameters
The request parameters for the route.
String routeId
The route ID.
String routeKey
The route key for the route.
String routeResponseSelectionExpression
The route response selection expression for the route.
String target
The target for the route.
AccessLogSettings accessLogSettings
Settings for logging access in this stage.
String apiId
The API identifier.
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.
String description
The description for the API stage.
Map<K,V> routeSettings
Route settings for the stage.
String stageName
The stage name.
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.
String clientCertificateId
The identifier of a client certificate for a Stage.
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.
String description
The description of the stage.
Date lastUpdatedDate
The timestamp when the stage was last updated.
Map<K,V> routeSettings
Route settings for the stage.
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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..
Copyright © 2019. All rights reserved.