Skip to content

API - Lense module

This module creates the Lense & Pillar resources on a provided AWS API Gateway.

Example

Typical Usage::

from stacks.resources.api_gateway.resources import lenses

lenses.create(stack, created_api_gateway, auth)

__create_get_lense(resource, response_model, request_validator, auth)

Create the GET Choice methods on the provided REST API Gateway Resource.

Creates a GET method on the /{model_name} resource to fetch the available lenses.

Attributes:

Name Type Description
resource aws_cdk.aws_apigateway.Resource

API Gateway resource where the resources and methods should be created.
response_model aws_cdk.aws_apigateway.Model

Model for the response validation.
auth aws_cdk.aws_apigateway.CognitoUserPoolsAuthorizer

Authorization for the endpoint.
Source code in infrastructure/stacks/resources/api_gateway/resources/lense.py 
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
def __create_get_lense(resource: apigateway.Resource, response_model: apigateway.Model, request_validator: apigateway.RequestValidator,  auth: apigateway.CognitoUserPoolsAuthorizer):
    """Create the GET Choice methods on the provided REST API Gateway Resource.

    Creates a GET method on the `/{model_name}` resource to fetch the available lenses.

    Attributes:
        resource (aws_cdk.aws_apigateway.Resource): API Gateway resource where the resources and methods should be created.
        response_model (aws_cdk.aws_apigateway.Model): Model for the response validation.
        auth (aws_cdk.aws_apigateway.CognitoUserPoolsAuthorizer): Authorization for the endpoint.
    """

    get_integration = apigateway.MockIntegration(
        integration_responses=[
                apigateway.IntegrationResponse(
                    status_code="200",  
                    response_parameters={
                        "method.response.header.Access-Control-Allow-Origin": "'*'"
                    },                                           
                    response_templates={
                        'application/json': json.dumps(LENSE_PROPER_NAME_MAP),
                    },
                )        
            ],
            passthrough_behavior=apigateway.PassthroughBehavior.NEVER,
            request_templates={
                    'application/json': json.dumps(
                        {
                            "statusCode": 200,
                        }
                    ),
                },  
    )


    success_response_200 = apigateway.MethodResponse(
        status_code='200',
        response_models={ "application/json": response_model}, 
        response_parameters={ 'method.response.header.Access-Control-Allow-Origin': True }
    )


    resource.add_method(
        'GET', 
        integration=get_integration, 
        method_responses=[
            success_response_200,
            __ERROR_METHOD_RESPONSE_400, 
            __ERROR_METHOD_RESPONSE_500
        ],
        request_validator=request_validator,
        authorizer=auth, 
        authorization_type=apigateway.AuthorizationType.COGNITO
    )

__create_get_pillar(resource, response_model, request_validator, auth)

Create the GET Choice methods on the provided REST API Gateway Resource.

Creates a GET method on the /{model_name}/pillars resource to fetch the available pillars.

Attributes:

Name Type Description
resource aws_cdk.aws_apigateway.Resource

API Gateway resource where the resources and methods should be created.
response_model aws_cdk.aws_apigateway.Model

Model for the response validation.
auth aws_cdk.aws_apigateway.CognitoUserPoolsAuthorizer

Authorization for the endpoint.
Source code in infrastructure/stacks/resources/api_gateway/resources/lense.py 
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def __create_get_pillar(resource: apigateway.Resource, response_model: apigateway.Model, request_validator: apigateway.RequestValidator,  auth: apigateway.CognitoUserPoolsAuthorizer):
    """Create the GET Choice methods on the provided REST API Gateway Resource.

    Creates a GET method on the `/{model_name}/pillars` resource to fetch the available pillars.

    Attributes:
        resource (aws_cdk.aws_apigateway.Resource): API Gateway resource where the resources and methods should be created.
        response_model (aws_cdk.aws_apigateway.Model): Model for the response validation.
        auth (aws_cdk.aws_apigateway.CognitoUserPoolsAuthorizer): Authorization for the endpoint.
    """

    get_integration = apigateway.MockIntegration(
        integration_responses=[
                apigateway.IntegrationResponse(
                    status_code="200",
                    response_parameters={
                        "method.response.header.Access-Control-Allow-Origin": "'*'"
                    },                         
                    response_templates={
                        'application/json': json.dumps(PILLAR_PROPER_NAME_MAP),
                    },
                )        
            ],
            passthrough_behavior=apigateway.PassthroughBehavior.NEVER,
            request_templates={
                    'application/json': json.dumps(
                        {
                            "statusCode": 200,
                        }
                    ),
                },  
    )


    success_response_200 = apigateway.MethodResponse(
        status_code='200',
        response_models={ "application/json": response_model}, 
        response_parameters={ 'method.response.header.Access-Control-Allow-Origin': True }
    )


    resource.add_method(
        'GET', 
        integration=get_integration, 
        method_responses=[
            success_response_200,
            __ERROR_METHOD_RESPONSE_400, 
            __ERROR_METHOD_RESPONSE_500
        ],
        request_validator=request_validator,
        authorizer=auth, 
        authorization_type=apigateway.AuthorizationType.COGNITO
    )

__create_model(rest_api_gateway, name, content, schema, description='')

Helper method to create a model.

Attributes:

Name Type Description
rest_api_gateway aws_cdk.aws_apigateway.RestApi

API Gateway the request validator belongs to.
name str

Name of the model.
content str

Content of the schema, e.g. application/json
schema aws_cdk.aws_apigateway.JsonSchema

Schema for the model.
description Optional[str]

Description of the model.

Returns:

Type Description

aws_cdk.aws_apigateway.Model: The created model.
Source code in infrastructure/stacks/resources/api_gateway/resources/lense.py 
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
def __create_model(rest_api_gateway: apigateway.RestApi, name: str, content: str, schema: apigateway.JsonSchema, description: Optional[str] = ""):
    """Helper method to create a model.

    Attributes:
        rest_api_gateway (aws_cdk.aws_apigateway.RestApi): API Gateway the request validator belongs to.
        name (str): Name of the model.
        content (str): Content of the schema, e.g. `application/json`
        schema (aws_cdk.aws_apigateway.JsonSchema): Schema for the model.
        description (Optional[str]): Description of the model.

    Returns:
        aws_cdk.aws_apigateway.Model: The created model.
    """

    model_id: str = "WaReviewTool" + name

    model = rest_api_gateway.add_model(
        model_id,
        content_type=content,
        description=description,
        model_name=name,
        schema=schema
    )

    return model

__create_request_validator(stack, rest_api_gateway, name)

Helper method to create a request validator.

Attributes:

Name Type Description
stack aws_cdk.aws_core.Stack

AWS CDK Stack to which it is deployed.
rest_api_gateway aws_cdk.aws_apigateway.RestApi

API Gateway the request validator belongs to.
name str

Name of the request validator.

Returns:

Type Description
apigateway.RequestValidator

aws_cdk.aws_apigateway.RequestValidator: The created request validator.
Source code in infrastructure/stacks/resources/api_gateway/resources/lense.py 
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
def __create_request_validator(stack: core.Stack, rest_api_gateway: apigateway.RestApi, name: str) -> apigateway.RequestValidator:
    """Helper method to create a request validator.

    Attributes:
        stack (aws_cdk.aws_core.Stack): AWS CDK Stack to which it is deployed.
        rest_api_gateway (aws_cdk.aws_apigateway.RestApi): API Gateway the request validator belongs to.
        name (str): Name of the request validator.

    Returns:
        aws_cdk.aws_apigateway.RequestValidator: The created request validator.
    """

    request_validator_id = "WaReview" + name + "RequestValidator"

    request_validator = apigateway.RequestValidator(
            stack,
            request_validator_id,
            rest_api=rest_api_gateway, 
            validate_request_body=True,
            validate_request_parameters=False
        )    
    return request_validator

create(stack, rest_api_gateway, auth, model_name='lense')

Create the API resource and methods on the provided REST API Gateway.

Attributes:

Name Type Description
stack aws_cdk.core.Stack

CDK Stack.

rest_api_gateway aws_cdk.aws_apigateway.RestApi

Rest API to add to.
auth aws_cdk.aws_cognito.CognitoUserPoolsAuthorizer

Cognito User Pool Authorizer used for the endpoint authentication.
model_name Optional[str]

The path for the resources, default choices.
Source code in infrastructure/stacks/resources/api_gateway/resources/lense.py 
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def create(stack: core.Stack, rest_api_gateway: apigateway.RestApi, auth: apigateway.CognitoUserPoolsAuthorizer, model_name: str = "lense") -> None:
    """Create the API resource and methods on the provided REST API Gateway.

    Attributes:
        stack (aws_cdk.core.Stack): CDK Stack.        
        rest_api_gateway (aws_cdk.aws_apigateway.RestApi): Rest API to add to.
        auth (aws_cdk.aws_cognito.CognitoUserPoolsAuthorizer): Cognito User Pool Authorizer used for the endpoint authentication.
        model_name (Optional[str]): The path for the resources, default `choices`.

    """

    ##########
    # Models
    ##########


    get_lense_response_model_schema = apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.OBJECT,
        required=["wellarchitected", "foundationaltechni", "serverless", "softwareasaservice"],
        properties={
            "wellarchitected": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            ),
            "foundationaltechni": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
            ),
            "serverless": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            ),   
            "softwareasaservice": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
            )
        }
    )

    get_lense_response_model = __create_model(rest_api_gateway=rest_api_gateway, name="GetLenseResponseModel", content="application/json", schema=get_lense_response_model_schema, description="Validate the response body")    

    get_pillar_response_model_schema = apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.OBJECT,
        required=["operationalExcellence", "security", "reliability", "performance", "costOptimization"],
        properties={
            "operationalExcellence": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            ),
            "security": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
            ),
            "reliability": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING
            ),   
            "performance": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
            ),   
            "costOptimization": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
            )
        }
    )

    get_pillar_response_model = __create_model(rest_api_gateway=rest_api_gateway, name="GetPillarResponseModel", content="application/json", schema=get_pillar_response_model_schema, description="Validate the response body")    

    #
    ## Resources and Methods
    #
    request_validator = __create_request_validator(stack=stack, rest_api_gateway=rest_api_gateway, name="Lense")

    lense_resource = rest_api_gateway.root.add_resource(model_name.lower())

    __create_get_lense(resource=lense_resource, response_model=get_lense_response_model, request_validator=request_validator, auth=auth)

    pillar_resource = lense_resource.add_resource('pillars')

    __create_get_pillar( resource=pillar_resource, response_model=get_pillar_response_model, request_validator=request_validator, auth=auth)