MethodArgs class
The set of arguments for Method. The set of arguments for Method.
Constructors
-
MethodArgs({Input<
bool?> ? apiKeyRequired, required Input<String> authorization, Input<List< ? authorizationScopes, Input<String> ?>String?> ? authorizerId, required Input<String> httpMethod, Input<String?> ? operationName, Input<String?> ? region, Input<Map< ? requestModels, Input<String, String> ?>Map< ? requestParameters, Input<String, bool> ?>String?> ? requestValidatorId, required Input<String> resourceId, required Input restApi}) -
Creates a new MethodArgs.
apiKeyRequiredSpecify if the method requires an API keyauthorizationType of authorization used for the method (NONE,CUSTOM,AWS_IAM,COGNITO_USER_POOLS)authorizationScopesAuthorization scopes used when the authorization isCOGNITO_USER_POOLSauthorizerIdAuthorizer id to be used when the authorization isCUSTOMorCOGNITO_USER_POOLShttpMethodHTTP Method (GET,POST,PUT,DELETE,HEAD,OPTIONS,ANY)operationNameFunction 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requestModelsMap of the API models used for the request's content type where key is the content type (e.g.,application/json) and value is eitherError,Empty(built-in models) oraws.apigateway.Model'sname.requestParametersMap 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 headerX-Some-Headerand the query stringsome-query-parammust be provided in the request.requestValidatorIdID of aaws.apigateway.RequestValidatorresourceIdAPI resource IDrestApiID of the associated REST APIconst -
MethodArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
apiKeyRequired
→ Input<
bool?> ? -
Specify if the method requires an API key
final
-
Type of authorization used for the method (
NONE,CUSTOM,AWS_IAM,COGNITO_USER_POOLS)final -
Authorization scopes used when the authorization is
COGNITO_USER_POOLSfinal -
Authorizer id to be used when the authorization is
CUSTOMorCOGNITO_USER_POOLSfinal - 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 eitherError,Empty(built-in models) oraws.apigateway.Model'sname.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 headerX-Some-Headerand the query stringsome-query-parammust be provided in the request.final -
requestValidatorId
→ Input<
String?> ? -
ID of a
aws.apigateway.RequestValidatorfinal -
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