MethodState class

Input properties used for looking up and filtering Method resources.

Constructors

MethodState({Input<bool?>? apiKeyRequired, Input<String?>? authorization, Input<List<String>?>? authorizationScopes, Input<String?>? authorizerId, Input<String?>? httpMethod, Input<String?>? operationName, Input<String?>? region, Input<Map<String, String>?>? requestModels, Input<Map<String, bool>?>? requestParameters, Input<String?>? requestValidatorId, Input<String?>? resourceId, Input? restApi})
Creates a new MethodState. apiKeyRequired Specify if the method requires an API key authorization Type of authorization used for the method (NONE, CUSTOM, AWS_IAM, COGNITO_USER_POOLS) authorizationScopes Authorization scopes used when the authorization is COGNITO_USER_POOLS authorizerId Authorizer id to be used when the authorization is CUSTOM or COGNITO_USER_POOLS httpMethod HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY) operationName Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. requestModels Map of the API models used for the request's content type where key is the content type (e.g., application/json) and value is either Error, Empty (built-in models) or aws.apigateway.Model's name. requestParameters Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (true) or optional (false). For example: requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true} would define that the header X-Some-Header and the query string some-query-param must be provided in the request. requestValidatorId ID of a aws.apigateway.RequestValidator resourceId API resource ID restApi ID of the associated REST API
const
MethodState.fromMap(Map<String, dynamic> map)
factory

Properties

apiKeyRequired → Input<bool?>?
Specify if the method requires an API key
final
authorization → Input<String?>?
Type of authorization used for the method (NONE, CUSTOM, AWS_IAM, COGNITO_USER_POOLS)
final
authorizationScopes → Input<List<String>?>?
Authorization scopes used when the authorization is COGNITO_USER_POOLS
final
authorizerId → Input<String?>?
Authorizer id to be used when the authorization is CUSTOM or COGNITO_USER_POOLS
final
hashCode → int
The hash code for this object.
no setterinherited
httpMethod → Input<String?>?
HTTP Method (GET, POST, PUT, DELETE, HEAD, OPTIONS, ANY)
final
operationName → Input<String?>?
Function name that will be given to the method when generating an SDK through API Gateway. If omitted, API Gateway will generate a function name based on the resource path and HTTP verb.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
requestModels → Input<Map<String, String>?>?
Map of the API models used for the request's content type where key is the content type (e.g., application/json) and value is either Error, Empty (built-in models) or aws.apigateway.Model's name.
final
requestParameters → Input<Map<String, bool>?>?
Map of request parameters (from the path, query string and headers) that should be passed to the integration. The boolean value indicates whether the parameter is required (true) or optional (false). For example: requestParameters = {"method.request.header.X-Some-Header" = true "method.request.querystring.some-query-param" = true} would define that the header X-Some-Header and the query string some-query-param must be provided in the request.
final
requestValidatorId → Input<String?>?
ID of a aws.apigateway.RequestValidator
final
resourceId → Input<String?>?
API resource ID
final
restApi → Input?
ID of the associated REST API
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited