Class: Aws::APIGateway::Types::PutMethodRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::PutMethodRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
Request to add a method to an existing Resource resource.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#api_key_required ⇒ Boolean
Specifies whether the method required a valid ApiKey.
-
#authorization_scopes ⇒ Array<String>
A list of authorization scopes configured on the method.
-
#authorization_type ⇒ String
The method's authorization type.
-
#authorizer_id ⇒ String
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.
-
#http_method ⇒ String
Specifies the method request's HTTP method type.
-
#operation_name ⇒ String
A human-friendly operation identifier for the method.
-
#request_models ⇒ Hash<String,String>
Specifies the Model resources used for the request's content type.
-
#request_parameters ⇒ Hash<String,Boolean>
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
-
#request_validator_id ⇒ String
The identifier of a RequestValidator for validating the method request.
-
#resource_id ⇒ String
The Resource identifier for the new Method resource.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
Instance Attribute Details
#api_key_required ⇒ Boolean
Specifies whether the method required a valid ApiKey.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#authorization_scopes ⇒ Array<String>
A list of authorization scopes configured on the method. The scopes
are used with a COGNITO_USER_POOLS
authorizer to authorize the
method invocation. The authorization works by matching the method
scopes against the scopes parsed from the access token in the
incoming request. The method invocation is authorized if any method
scopes matches a claimed scope in the access token. Otherwise, the
invocation is not authorized. When the method scope is configured,
the client must provide an access token instead of an identity token
for authorization purposes.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#authorization_type ⇒ String
The method's authorization type. Valid values are NONE
for open
access, AWS_IAM
for using AWS IAM permissions, CUSTOM
for using
a custom authorizer, or COGNITO_USER_POOLS
for using a Cognito
user pool.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#authorizer_id ⇒ String
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#http_method ⇒ String
Specifies the method request's HTTP method type.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#operation_name ⇒ String
A human-friendly operation identifier for the method. For example,
you can assign the operationName
of ListPets
for the GET /pets
method in the PetStore
example.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#request_models ⇒ Hash<String,String>
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#request_parameters ⇒ Hash<String,Boolean>
A key-value map defining required or optional method request
parameters that can be accepted by API Gateway. A key defines a
method request parameter name matching the pattern of
method.request.\{location\}.\{name\}
, where location
is
querystring
, path
, or header
and name
is a valid and unique
parameter name. The value associated with the key is a Boolean flag
indicating whether the parameter is required (true
) or optional
(false
). The method request parameter names defined here are
available in Integration to be mapped to integration request
parameters or body-mapping templates.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#request_validator_id ⇒ String
The identifier of a RequestValidator for validating the method request.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#resource_id ⇒ String
The Resource identifier for the new Method resource.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4259 class PutMethodRequest < Struct.new( :rest_api_id, :resource_id, :http_method, :authorization_type, :authorizer_id, :api_key_required, :operation_name, :request_parameters, :request_models, :request_validator_id, :authorization_scopes) SENSITIVE = [] include Aws::Structure end |