Skip to content

API - Workloads module

This module creates the Workloads resources on a provided AWS API Gateway.

Example

Typical Usage::

from stacks.resources.api_gateway.resources import workloads

workloads.create(stack, created_api_gateway, wa_workload_function_arn, auth)

__create_get_workload(wa_workload_function, resource, response_model, request_validator, auth)

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

Creates a GET method on the /{model_name}/{id} resource to fetch one workloads from AWS.

Attributes:

Name Type Description
wa_workload_function aws_cdk.aws_lambda.Function
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/workloads.py 
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
280
281
282
283
284
285
286
287
288
def __create_get_workload( wa_workload_function: Function, resource: apigateway.Resource, response_model: apigateway.Model, request_validator: apigateway.RequestValidator,  auth: apigateway.CognitoUserPoolsAuthorizer):
    """Create the GET Workload methods on the provided REST API Gateway Resource.

    Creates a GET method on the `/{model_name}/{id}` resource to fetch one workloads from AWS.

    Attributes:
        wa_workload_function (aws_cdk.aws_lambda.Function): 
        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.LambdaIntegration(
        wa_workload_function,
        proxy=False,
        integration_responses=[
                apigateway.IntegrationResponse(
                    status_code="200",
                    response_parameters={
                        "method.response.header.Access-Control-Allow-Origin": "'*'"
                    },                       
                ),
                apigateway.IntegrationResponse(
                    selection_pattern=".*\"failure\".*",
                    status_code="500",
                    response_templates= {
                        "application/json": '{"error": "Internal Service Error"}'
                    }
                )            ],
        request_templates={
                'application/json': json.dumps(
                    { 
                        "workload_id": "$method.request.path.id"
                    }
                ),
            },
    )


    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_workload_history(ddb_role, dynamodb_pkey_id, dynamodb_table, resource, response_model, request_validator, auth)

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

Creates a GET method on the /{model_name}/{id}/history resource to fetch the risk history of the workloads from DynamoDB.

Attributes:

Name Type Description
ddb_role aws_cdk.aws_iam.Role

The IAM Role to access the DB from the API Gateway.
dynamodb_pkey_id str

DynamoDB Table primary key name.
dynamodb_table aws_cdk.aws_dynamodb.Table

The DynamoDB Table.
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/workloads.py 
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
def __create_get_workload_history( ddb_role: Role, dynamodb_pkey_id: str, dynamodb_table: Table, resource: apigateway.Resource, response_model: apigateway.Model, request_validator: apigateway.RequestValidator,  auth: apigateway.CognitoUserPoolsAuthorizer):
    """Create the GET Workload methods on the provided REST API Gateway Resource.

    Creates a GET method on the `/{model_name}/{id}/history` resource to fetch the risk history of the workloads from DynamoDB.

    Attributes:
        ddb_role (aws_cdk.aws_iam.Role): The IAM Role to access the DB from the API Gateway.
        dynamodb_pkey_id (str): DynamoDB Table primary key name.
        dynamodb_table (aws_cdk.aws_dynamodb.Table): The DynamoDB Table.
        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.AwsIntegration(
        service="dynamodb",
        action="Query",
        options= apigateway.IntegrationOptions(
            credentials_role=ddb_role,
            passthrough_behavior=apigateway.PassthroughBehavior.NEVER,
            integration_responses=[
                apigateway.IntegrationResponse(
                    status_code="200",
                    selection_pattern="200",
                    response_parameters={
                        "method.response.header.Access-Control-Allow-Origin": "'*'"
                    },                    
                    response_templates= {
                        "application/json": '''
                            #set($inputRoot = $input.path('$'))
                            {
                            "WorkloadId": "$method.request.path.id",
                            "Data": [
                                #foreach($elem in $inputRoot.Items)
                                    {
                                        "UpdatedAt": "$elem.updated_at.S",
                                        "RiskCounts": {
                                            "UNANSWERED": $elem.risk_unanswered.N,
                                            "NONE": $elem.risk_none.N,
                                            "MEDIUM": $elem.risk_medium.N,
                                            "HIGH": $elem.risk_high.N
                                        }
                                    }#if($foreach.hasNext),#end
                                #end
                                ]                        
                            }
                        '''
                    }
                ),
                __ERROR_INTEGRATION_RESPONSE_400,
                __ERROR_INTEGRATION_RESPONSE_500
            ],
            request_templates= {
                'application/json': json.dumps({
                    "KeyConditionExpression" : f"{dynamodb_pkey_id} = :pkey",
                    "ExpressionAttributeValues": {
                        ":pkey": { "S": "$method.request.path.id" }
                    },
                    "TableName": dynamodb_table.table_name
                    }),
            },
        ),
    )

    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_workloads(wa_workload_function, resource, response_model, request_validator, auth)

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

Creates a GET method on the /{model_name} resource to fetch all workloads from AWS.

Attributes:

Name Type Description
wa_workload_function aws_cdk.aws_lambda.Function
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/workloads.py 
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
def __create_get_workloads( wa_workload_function: Function, resource: apigateway.Resource, response_model: apigateway.Model, request_validator: apigateway.RequestValidator,  auth: apigateway.CognitoUserPoolsAuthorizer):
    """Create the GET Workloads methods on the provided REST API Gateway Resource.

    Creates a GET method on the `/{model_name}` resource to fetch all workloads from AWS.

    Attributes:
        wa_workload_function (aws_cdk.aws_lambda.Function): 
        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.LambdaIntegration(
        wa_workload_function,
        proxy=False,
        integration_responses=[
                apigateway.IntegrationResponse(
                    status_code="200",
                    response_parameters={
                        "method.response.header.Access-Control-Allow-Origin": "'*'"
                    },                       
                ),
                apigateway.IntegrationResponse(
                    selection_pattern=".*\"failure\".*",
                    status_code="500",
                    response_templates= {
                        "application/json": '{"error": "Internal Service Error"}'
                    }
                )            ],
        request_templates={
                'application/json': json.dumps(
                    { 
                        "workload_id": "ALL",
                        "workload_prefix": "$input.path('$.workload_prefix')",
                    }
                ),
            },
    )


    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/workloads.py 
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
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/workloads.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
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, wa_workload_function_arn, dynamodb_table_arn, auth, dynamodb_pkey_id='workload_id', model_name='workload')

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.
wa_workload_function_arn str

ARN of the Lambda function which fetchs the Workloads from AWS.
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 workload.
Source code in infrastructure/stacks/resources/api_gateway/resources/workloads.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
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
175
176
177
178
179
def create(
    stack: core.Stack, 
    rest_api_gateway: apigateway.RestApi, 
    wa_workload_function_arn: str, 
    dynamodb_table_arn: str, 
    auth: apigateway.CognitoUserPoolsAuthorizer,
    dynamodb_pkey_id: str = "workload_id", 
    model_name: str = "workload") -> 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.
        wa_workload_function_arn (str): ARN of the Lambda function which fetchs the Workloads from AWS.
        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 `workload`.

    """

    dynamodb_table = Table.from_table_arn(stack, "WaReviewToolWorkloadTrackerDynamoDbTable", dynamodb_table_arn)

    ddb_write_role = create_integration_iam_role(stack, ["dynamodb:UpdateItem", "dynamodb:PutItem"], [dynamodb_table_arn], "WaReviewWorkloadTrackerDynamoDbPut")
    ddb_get_role = create_integration_iam_role(stack, ["dynamodb:GetItem", "dynamodb:Query", "dynamodb:Scan"], [dynamodb_table_arn], "WaReviewWorkloadTrackerDynamoDbGet")
    ddb_delete_role = create_integration_iam_role(stack, ["dynamodb:DeleteItem"], [dynamodb_table_arn], "WaReviewWorkloadTrackerDynamoDbDelete")

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

    get_workload_response_model_schema = apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.OBJECT,
        required=["workload_id" ],
        properties={
            "workload_prefix": apigateway.JsonSchema(type=apigateway.JsonSchemaType.STRING),
            "workload_id": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
                # pattern="^[a-fA-F0-9]{10,14})$"
                ),
        }
    )
    get_workload_response_model = __create_model(rest_api_gateway=rest_api_gateway, name="GetWorkloadResponseModel", content="application/json", schema=get_workload_response_model_schema, description="Validate the response body")    

    get_workloads_response_model_schema = apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.ARRAY,
        items=get_workload_response_model_schema
    )

    get_workloads_response_model = __create_model(rest_api_gateway=rest_api_gateway, name="GetWorkloadsResponseModel", content="application/json", schema=get_workloads_response_model_schema, description="Validate the response body")    

    # TODO: Add more
    get_workload_hitsory_response_model_schema = apigateway.JsonSchema(
        type=apigateway.JsonSchemaType.OBJECT,
        required=["workload_id" ],
        properties={
            "workload_id": apigateway.JsonSchema(
                type=apigateway.JsonSchemaType.STRING,
                # pattern="^[a-fA-F0-9]{10,14})$"
                ),
        }
    )

    get_workload_history_response_model = __create_model(rest_api_gateway=rest_api_gateway, name="GetWorkloadHistoryResponseModel", content="application/json", schema=get_workload_hitsory_response_model_schema, description="Validate the response body")    

    #
    ## Functions
    #     

    wa_workload_function = Function.from_function_arn(stack, "WaReviewToolWaWorkloadsFunction", wa_workload_function_arn)

    CfnPermission(
        stack,
        'WaReviewToolWaWorkloadsFunctionPermission',
        action="lambda:InvokeFunction",
        function_name=wa_workload_function_arn,
        principal='apigateway.amazonaws.com',
        source_arn=rest_api_gateway.arn_for_execute_api() 
    )

    #
    ## Resources and Methods
    #

    request_validator = __create_request_validator(stack=stack, rest_api_gateway=rest_api_gateway, name="Workloads")

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

    __create_get_workloads(wa_workload_function=wa_workload_function, resource=workloads_resource, response_model=get_workloads_response_model, request_validator=request_validator, auth=auth)

    workload_resource = workloads_resource.add_resource('{id}')
    __create_get_workload(wa_workload_function=wa_workload_function, resource=workload_resource, response_model=get_workload_response_model, request_validator=request_validator, auth=auth)

    workload_history_resource = workload_resource.add_resource('history')
    __create_get_workload_history(dynamodb_pkey_id=dynamodb_pkey_id, ddb_role=ddb_get_role, dynamodb_table=dynamodb_table, resource=workload_history_resource, response_model=get_workload_history_response_model, request_validator=request_validator, auth=auth)