aws-cdk-lib.aws_apigateway.MethodOptions

MethodOptions Struct

MethodOptions

used as props by

• ApiEventSource

Source

aws-apigateway/lib/method.ts

Example

    declare const api: apigateway.RestApi;
    declare const userLambda: lambda.Function;

    const userModel: apigateway.Model = api.addModel('UserModel', {
        schema: {
            type: apigateway.JsonSchemaType.OBJECT,
            properties: {
                userId: {
                    type: apigateway.JsonSchemaType.STRING
                },
                name: {
                    type: apigateway.JsonSchemaType.STRING
                }
            },
            required: ['userId']
        }
    });
    api.root.addResource('user').addMethod('POST',
        new apigateway.LambdaIntegration(userLambda), {
            requestModels: {
                'application/json': userModel
            }
        }
    );

# api: apigateway.RestApi
# user_lambda: lambda.Function


user_model = api.add_model("UserModel",
    schema=apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.OBJECT,
        properties={
            "user_id": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            ),
            "name": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            )
        },
        required=["userId"]
    )
)
api.root.add_resource("user").add_method("POST",
    apigateway.LambdaIntegration(user_lambda),
        request_models={
            "application/json": user_model
        }
    )

RestApi api;
Function userLambda;


Model userModel = api.addModel("UserModel", ModelOptions.builder()
        .schema(JsonSchema.builder()
                .type(JsonSchemaType.OBJECT)
                .properties(Map.of(
                        "userId", JsonSchema.builder()
                                .type(JsonSchemaType.STRING)
                                .build(),
                        "name", JsonSchema.builder()
                                .type(JsonSchemaType.STRING)
                                .build()))
                .required(List.of("userId"))
                .build())
        .build());
api.root.addResource("user").addMethod("POST",
new LambdaIntegration(userLambda), MethodOptions.builder()
        .requestModels(Map.of(
                "application/json", userModel))
        .build());

// Install: dotnet add package Amazon.CDK.Lib
RestApi api;
Function userLambda;


var userModel = api.AddModel("UserModel", new ModelOptions {
    Schema = new JsonSchema {
        Type = JsonSchemaType.OBJECT,
        Properties = new Dictionary<string, JsonSchema> {
            { "userId", new JsonSchema {
                Type = JsonSchemaType.STRING
            } },
            { "name", new JsonSchema {
                Type = JsonSchemaType.STRING
            } }
        },
        Required = new [] { "userId" }
    }
});
api.Root.AddResource("user").AddMethod("POST",
new LambdaIntegration(userLambda), new MethodOptions {
    RequestModels = new Dictionary<string, IModel> {
        { "application/json", userModel }
    }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var api RestApi
var userLambda Function


userModel := api.AddModel(jsii.String("UserModel"), &ModelOptions{
	Schema: &JsonSchema{
		Type: apigateway.JsonSchemaType_OBJECT,
		Properties: map[string]JsonSchema{
			"userId": &JsonSchema{
				"type": apigateway.JsonSchemaType_STRING,
			},
			"name": &JsonSchema{
				"type": apigateway.JsonSchemaType_STRING,
			},
		},
		Required: []*string{
			jsii.String("userId"),
		},
	},
})
api.Root.AddResource(jsii.String("user")).AddMethod(jsii.String("POST"),
apigateway.NewLambdaIntegration(userLambda), &MethodOptions{
	RequestModels: map[string]IModel{
		"application/json": userModel,
	},
})

Properties

apiKeyRequired?optionalbooleanapi_key_required?optionalboolapiKeyRequired?optionalBooleanApiKeyRequired?optionalboolApiKeyRequired?optional*bool= false#

Indicates whether the method requires clients to submit a valid API key.

authorizationScopes?optionalstring[]authorization_scopes?optionaltyping.List[str]authorizationScopes?optionalList<String>AuthorizationScopes?optionalstring[]AuthorizationScopes?optional*[]*string#

A list of authorization scopes configured on the method.

Default: no authorization scopes

The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

authorizationType?optionalAuthorizationTypeauthorization_type?optionalAuthorizationTypeauthorizationType?optionalAuthorizationTypeAuthorizationType?optionalAuthorizationTypeAuthorizationType?optionalAuthorizationType#

Method authorization. If the value is set of `Custom`, an `authorizer` must also be specified.

Default: open access unless authorizer is specified

notes

If you're using one of the authorizers that are available via the Authorizer class, such as Authorizer#token(), it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type. However, specifying an authorization type using this property that conflicts with what is expected by the Authorizer will result in an error.

authorizer?optionalIAuthorizerauthorizer?optionalIAuthorizerauthorizer?optionalIAuthorizerAuthorizer?optionalIAuthorizerAuthorizer?optionalIAuthorizer#

If `authorizationType` is `Custom`, this specifies the ID of the method authorizer resource.

If specified, the value of authorizationType must be set to Custom

methodResponses?optionalMethodResponse[]method_responses?optionaltyping.List[MethodResponse]methodResponses?optionalList<MethodResponse>MethodResponses?optionalMethodResponse[]MethodResponses?optional*[]MethodResponse#

The responses that can be sent to the client who calls the method.

Default: None This property is not required, but if these are not supplied for a Lambda proxy integration, the Lambda function must return a value of the correct format, for the integration response to be correctly mapped to a response to the client.

operationName?optionalstringoperation_name?optionalstroperationName?optionalStringOperationName?optionalstringOperationName?optional*string#

A friendly operation name for the method.

For example, you can assign the OperationName of ListPets for the GET /pets method.

requestModels?optional{ [key: string]: IModel }request_models?optionaltyping.Mapping[str, IModel]requestModels?optionalMap<String, IModel>RequestModels?optionalIDictionary<string, IModel>RequestModels?optional*map[string]IModel#

The models which describe data structure of request payload.

notes · example

When combined with requestValidator or requestValidatorOptions, the service will validate the API request payload before it reaches the API's Integration (including proxies). Specify requestModels as key-value pairs, with a content type (e.g. 'application/json') as the key and an API Gateway Model as the value.

    declare const api: apigateway.RestApi;
    declare const userLambda: lambda.Function;

    const userModel: apigateway.Model = api.addModel('UserModel', {
        schema: {
            type: apigateway.JsonSchemaType.OBJECT,
            properties: {
                userId: {
                    type: apigateway.JsonSchemaType.STRING
                },
                name: {
                    type: apigateway.JsonSchemaType.STRING
                }
            },
            required: ['userId']
        }
    });
    api.root.addResource('user').addMethod('POST',
        new apigateway.LambdaIntegration(userLambda), {
            requestModels: {
                'application/json': userModel
            }
        }
    );

requestParameters?optional{ [key: string]: boolean }request_parameters?optionaltyping.Mapping[str, bool]requestParameters?optionalMap<String, Boolean>RequestParameters?optionalIDictionary<string, bool>RequestParameters?optional*map[string]*bool= None#

The request parameters that API Gateway accepts.

notes

Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. The Boolean specifies whether a parameter is required. A source must match the format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name.

requestValidator?optionalIRequestValidatorrequest_validator?optionalIRequestValidatorrequestValidator?optionalIRequestValidatorRequestValidator?optionalIRequestValidatorRequestValidator?optionalIRequestValidator#

The ID of the associated request validator.

Default: No default validator

Only one of requestValidator or requestValidatorOptions must be specified. Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.

requestValidatorOptions?optionalRequestValidatorOptionsrequest_validator_options?optionalRequestValidatorOptionsrequestValidatorOptions?optionalRequestValidatorOptionsRequestValidatorOptions?optionalRequestValidatorOptionsRequestValidatorOptions?optionalRequestValidatorOptions#

Request validator options to create new validator Only one of `requestValidator` or `requestValidatorOptions` must be specified.

Default: No default validator

Works together with requestModels or requestParameters to validate the request before it reaches integration like Lambda Proxy Integration.