Class: AWSCDK::APIGateway::ResponseType

Inherits:
Jsii::Object
  • Object
show all
Defined in:
api_gateway/response_type.rb

Overview

Supported types of gateway responses.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ ResponseType

Returns a new instance of ResponseType.

Raises:

  • (NoMethodError) 


10
11
12
 
# File 'api_gateway/response_type.rb', line 10

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_apigateway.ResponseType does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.ACCESS_DENIED ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for authorization failure.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


32
33
34
 
# File 'api_gateway/response_type.rb', line 32

def self.ACCESS_DENIED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "ACCESS_DENIED")
end

.API_CONFIGURATION_ERROR ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an invalid API configuration.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


39
40
41
 
# File 'api_gateway/response_type.rb', line 39

def self.API_CONFIGURATION_ERROR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "API_CONFIGURATION_ERROR")
end

.AUTHORIZER_CONFIGURATION_ERROR ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for failing to connect to a custom or Amazon Cognito authorizer.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


46
47
48
 
# File 'api_gateway/response_type.rb', line 46

def self.AUTHORIZER_CONFIGURATION_ERROR()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "AUTHORIZER_CONFIGURATION_ERROR")
end

.AUTHORIZER_FAILURE ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when a custom or Amazon Cognito authorizer failed to authenticate the caller.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


53
54
55
 
# File 'api_gateway/response_type.rb', line 53

def self.AUTHORIZER_FAILURE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "AUTHORIZER_FAILURE")
end

.BAD_REQUEST_BODY ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when the request body cannot be validated according to an enabled request validator.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


60
61
62
 
# File 'api_gateway/response_type.rb', line 60

def self.BAD_REQUEST_BODY()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "BAD_REQUEST_BODY")
end

.BAD_REQUEST_PARAMETERS ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when the request parameter cannot be validated according to an enabled request validator.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


67
68
69
 
# File 'api_gateway/response_type.rb', line 67

def self.BAD_REQUEST_PARAMETERS()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "BAD_REQUEST_PARAMETERS")
end

.DEFAULT_4_XX ⇒ AWSCDK::APIGateway::ResponseType

The default gateway response for an unspecified response type with the status code of 4XX.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


74
75
76
 
# File 'api_gateway/response_type.rb', line 74

def self.DEFAULT_4_XX()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "DEFAULT_4XX")
end

.DEFAULT_5_XX ⇒ AWSCDK::APIGateway::ResponseType

The default gateway response for an unspecified response type with a status code of 5XX.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


81
82
83
 
# File 'api_gateway/response_type.rb', line 81

def self.DEFAULT_5_XX()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "DEFAULT_5XX")
end

.EXPIRED_TOKEN ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an AWS authentication token expired error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


88
89
90
 
# File 'api_gateway/response_type.rb', line 88

def self.EXPIRED_TOKEN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "EXPIRED_TOKEN")
end

.INTEGRATION_FAILURE ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an integration failed error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


95
96
97
 
# File 'api_gateway/response_type.rb', line 95

def self.INTEGRATION_FAILURE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "INTEGRATION_FAILURE")
end

.INTEGRATION_TIMEOUT ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an integration timed out error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


102
103
104
 
# File 'api_gateway/response_type.rb', line 102

def self.INTEGRATION_TIMEOUT()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "INTEGRATION_TIMEOUT")
end

.INVALID_API_KEY ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an invalid API key submitted for a method requiring an API key.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


109
110
111
 
# File 'api_gateway/response_type.rb', line 109

def self.INVALID_API_KEY()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "INVALID_API_KEY")
end

.INVALID_SIGNATURE ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for an invalid AWS signature error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


116
117
118
 
# File 'api_gateway/response_type.rb', line 116

def self.INVALID_SIGNATURE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "INVALID_SIGNATURE")
end

.jsii_overridable_methods ⇒ Object 



14
15
16
17
18
 
# File 'api_gateway/response_type.rb', line 14

def self.jsii_overridable_methods
  {
    :response_type => { kind: :property, name: "responseType", is_optional: false },
  }
end

.MISSING_AUTHENTICATION_TOKEN ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for a missing authentication token error, including the cases when the client attempts to invoke an unsupported API method or resource.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


123
124
125
 
# File 'api_gateway/response_type.rb', line 123

def self.MISSING_AUTHENTICATION_TOKEN()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "MISSING_AUTHENTICATION_TOKEN")
end

.of(type) ⇒ AWSCDK::APIGateway::ResponseType

A custom response type to support future cases.

Parameters:

  • type (String)

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


24
25
26
27
 
# File 'api_gateway/response_type.rb', line 24

def self.of(type)
  Jsii::Type.check_type(type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_apigateway.ResponseType", "of", [type])
end

.QUOTA_EXCEEDED ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for the usage plan quota exceeded error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


130
131
132
 
# File 'api_gateway/response_type.rb', line 130

def self.QUOTA_EXCEEDED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "QUOTA_EXCEEDED")
end

.REQUEST_TOO_LARGE ⇒ AWSCDK::APIGateway::ResponseType

The gateway response for the request too large error.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


137
138
139
 
# File 'api_gateway/response_type.rb', line 137

def self.REQUEST_TOO_LARGE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "REQUEST_TOO_LARGE")
end

.RESOURCE_NOT_FOUND ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when API Gateway cannot find the specified resource after an API request passes authentication and authorization.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


144
145
146
 
# File 'api_gateway/response_type.rb', line 144

def self.RESOURCE_NOT_FOUND()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "RESOURCE_NOT_FOUND")
end

.THROTTLED ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when usage plan, method, stage, or account level throttling limits exceeded.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


151
152
153
 
# File 'api_gateway/response_type.rb', line 151

def self.THROTTLED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "THROTTLED")
end

.UNAUTHORIZED ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when the custom or Amazon Cognito authorizer failed to authenticate the caller.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


158
159
160
 
# File 'api_gateway/response_type.rb', line 158

def self.UNAUTHORIZED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "UNAUTHORIZED")
end

.UNSUPPORTED_MEDIA_TYPE ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when a payload is of an unsupported media type, if strict passthrough behavior is enabled.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


165
166
167
 
# File 'api_gateway/response_type.rb', line 165

def self.UNSUPPORTED_MEDIA_TYPE()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "UNSUPPORTED_MEDIA_TYPE")
end

.WAF_FILTERED ⇒ AWSCDK::APIGateway::ResponseType

The gateway response when a request is blocked by AWS WAF.

Returns:

  • (AWSCDK::APIGateway::ResponseType) 


172
173
174
 
# File 'api_gateway/response_type.rb', line 172

def self.WAF_FILTERED()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_apigateway.ResponseType", "WAF_FILTERED")
end

Instance Method Details

#response_type ⇒ String

Valid value of response type.

Returns:

  • (String) 


179
180
181
 
# File 'api_gateway/response_type.rb', line 179

def response_type()
  jsii_get_property("responseType")
end