Skip to content

[appmesh] Re-Implement HealthChecks to use protocol specific static methods #11640

@dfezzie

Description

@dfezzie

As part of our work in solidifying the L2 APIs for App Mesh, we have decided to use protocol specific static methods to generate instances of certain classes. This ensures options specific to each protocol are only exposed when creating the resource specific to that protocol.

Use Case

HealthChecks currently implement a flat interface. This leads to manual checking of parameters in our code as seen here and can cause confusion for customers.

Proposed Solution

Health checks should be declared using established patterns

appmesh.HealthCheck.http({
  healthyThreshold: 3,
  path: '/check-path',
});

There are some established defaults that exist to help the customer easily define health checks, these should remain with the exception being port. This field can be totally omitted as it should always be the same as the listener it belongs to.

HealthCheck should work for both Gateway and Virtual Node listeners.

Other

  • 👋 I may be able to implement this feature request
  • ⚠️ This feature might incur a breaking change

This is a 🚀 Feature Request

Metadata

Metadata

Assignees

Labels

@aws-cdk/aws-appmeshRelated to AWS App Mesheffort/mediumMedium work item – several days of effortfeature-requestA feature should be added or improved.p1

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions