GatewayResponseOptions¶
-
class
aws_cdk.aws_apigateway.GatewayResponseOptions(*, type, response_headers=None, status_code=None, templates=None)¶ Bases:
objectOptions to add gateway response.
- Parameters
type (
ResponseType) – Response type to associate with gateway response.response_headers (
Optional[Mapping[str,str]]) – Custom headers parameters for response. Default: - no headersstatus_code (
Optional[str]) – Http status code for response. Default: - standard http status code for the response type.templates (
Optional[Mapping[str,str]]) – Custom templates to get mapped as response. Default: - Response from api will be returned without applying any transformation.
Attributes
-
response_headers¶ Custom headers parameters for response.
- Default
no headers
- Return type
Optional[Mapping[str,str]]
-
status_code¶ Http status code for response.
- Default
standard http status code for the response type.
- Return type
Optional[str]
-
templates¶ Custom templates to get mapped as response.
- Default
Response from api will be returned without applying any transformation.
- Return type
Optional[Mapping[str,str]]
-
type¶ Response type to associate with gateway response.