class Amazonite::ApiGateway::PutMethodRequest

Overview

Request to add a method to an existing Resource resource.

Included Modules

JSON::Serializable

Defined in:

api_gateway/put_method_request.cr

Constructors

.new(rest_api_id : String, resource_id : String, http_method : String, authorization_type : String, authorizer_id : String | Nil = nil, api_key_required : Bool | Nil = nil, operation_name : String | Nil = nil, request_parameters : Hash(String, Bool) | Nil = nil, request_models : Hash(String, String) | Nil = nil, request_validator_id : String | Nil = nil, authorization_scopes : Array(String) | Nil = nil)
.new(pull : JSON::PullParser)
.new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#api_key_required : Bool | Nil
Specifies whether the method required a valid ApiKey.
#api_key_required=(api_key_required : Bool | Nil)
Specifies whether the method required a valid ApiKey.
#authorization_scopes : Array(String) | Nil
A list of authorization scopes configured on the method.
#authorization_scopes=(authorization_scopes : Array(String) | Nil)
A list of authorization scopes configured on the method.
#authorization_type : String
The method's authorization type.
#authorization_type=(authorization_type : String)
The method's authorization type.
#authorizer_id : String | Nil
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.
#authorizer_id=(authorizer_id : String | Nil)
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS.
#hash(hasher)
See Object#hash(hasher)
#http_method : String
Specifies the method request's HTTP method type.
#http_method=(http_method : String)
Specifies the method request's HTTP method type.
#operation_name : String | Nil
A human-friendly operation identifier for the method.
#operation_name=(operation_name : String | Nil)
A human-friendly operation identifier for the method.
#request_models : Hash(String, String) | Nil
Specifies the Model resources used for the request's content type.
#request_models=(request_models : Hash(String, String) | Nil)
Specifies the Model resources used for the request's content type.
#request_parameters : Hash(String, Bool) | Nil
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
#request_parameters=(request_parameters : Hash(String, Bool) | Nil)
A key-value map defining required or optional method request parameters that can be accepted by API Gateway.
#request_validator_id : String | Nil
The identifier of a RequestValidator for validating the method request.
#request_validator_id=(request_validator_id : String | Nil)
The identifier of a RequestValidator for validating the method request.
#resource_id : String
The Resource identifier for the new Method resource.
#resource_id=(resource_id : String)
The Resource identifier for the new Method resource.
#rest_api_id : String
The string identifier of the associated RestApi.
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
#validate! : Nil

Constructor Detail

def self.new(rest_api_id : String, resource_id : String, http_method : String, authorization_type : String, authorizer_id : String | Nil = nil, api_key_required : Bool | Nil = nil, operation_name : String | Nil = nil, request_parameters : Hash(String, Bool) | Nil = nil, request_models : Hash(String, String) | Nil = nil, request_validator_id : String | Nil = nil, authorization_scopes : Array(String) | Nil = nil) #

[View source]

def self.new(pull : JSON::PullParser) #

[View source]

def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #

Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.

def api_key_required : Bool | Nil #

Specifies whether the method required a valid ApiKey.

[View source]

def api_key_required=(api_key_required : Bool | Nil) #

Specifies whether the method required a valid ApiKey.

[View source]

def authorization_scopes : Array(String) | Nil #

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.

[View source]

def authorization_scopes=(authorization_scopes : Array(String) | Nil) #

[View source]

def 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.

[View source]

def authorization_type=(authorization_type : String) #

[View source]

def authorizer_id : String | Nil #

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.

[View source]

def authorizer_id=(authorizer_id : String | Nil) #

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.

[View source]

def hash(hasher) #

Description copied from class Reference

See Object#hash(hasher)

def http_method : String #

Specifies the method request's HTTP method type.

[View source]

def http_method=(http_method : String) #

Specifies the method request's HTTP method type.

[View source]

def operation_name : String | Nil #

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.

[View source]

def operation_name=(operation_name : String | Nil) #

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.

[View source]

def request_models : Hash(String, String) | Nil #

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.

[View source]

def request_models=(request_models : Hash(String, String) | Nil) #

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.

[View source]

def request_parameters : Hash(String, Bool) | Nil #

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.

[View source]

def request_parameters=(request_parameters : Hash(String, Bool) | Nil) #

[View source]

def request_validator_id : String | Nil #

The identifier of a RequestValidator for validating the method request.

[View source]

def request_validator_id=(request_validator_id : String | Nil) #

The identifier of a RequestValidator for validating the method request.

[View source]

def resource_id : String #

The Resource identifier for the new Method resource.

[View source]

def resource_id=(resource_id : String) #

The Resource identifier for the new Method resource.

[View source]

def rest_api_id : String #

The string identifier of the associated RestApi.

[View source]

def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.

[View source]

def validate! : Nil #

[View source]