MethodArgs constructor
- Input<
bool?> ? apiKeyRequired, - required Input<
String> authorization, - Input<
List< ? authorizationScopes,String> ?> - Input<
String?> ? authorizerId, - required Input<
String> httpMethod, - Input<
String?> ? operationName, - Input<
String?> ? region, - Input<
Map< ? requestModels,String, String> ?> - Input<
Map< ? requestParameters,String, bool> ?> - Input<
String?> ? requestValidatorId, - required Input<
String> resourceId, - required Input restApi,
Creates a new MethodArgs.
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
Implementation
const MethodArgs({
this.apiKeyRequired,
required this.authorization,
this.authorizationScopes,
this.authorizerId,
required this.httpMethod,
this.operationName,
this.region,
this.requestModels,
this.requestParameters,
this.requestValidatorId,
required this.resourceId,
required this.restApi,
});