libZSservicesZSamazonka-appmeshZSamazonka-appmesh
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppMesh.Lens

Contents

Description

 
Synopsis

Operations

DescribeVirtualNode

describeVirtualNode_meshOwner :: Lens' DescribeVirtualNode (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeVirtualNode_meshName :: Lens' DescribeVirtualNode Text Source #

The name of the service mesh that the virtual node resides in.

describeVirtualNode_virtualNodeName :: Lens' DescribeVirtualNode Text Source #

The name of the virtual node to describe.

DescribeVirtualGateway

describeVirtualGateway_meshOwner :: Lens' DescribeVirtualGateway (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeVirtualGateway_meshName :: Lens' DescribeVirtualGateway Text Source #

The name of the service mesh that the gateway route resides in.

DescribeRoute

describeRoute_meshOwner :: Lens' DescribeRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeRoute_meshName :: Lens' DescribeRoute Text Source #

The name of the service mesh that the route resides in.

describeRoute_routeName :: Lens' DescribeRoute Text Source #

The name of the route to describe.

describeRoute_virtualRouterName :: Lens' DescribeRoute Text Source #

The name of the virtual router that the route is associated with.

DescribeVirtualRouter

describeVirtualRouter_meshOwner :: Lens' DescribeVirtualRouter (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeVirtualRouter_meshName :: Lens' DescribeVirtualRouter Text Source #

The name of the service mesh that the virtual router resides in.

describeVirtualRouter_virtualRouterName :: Lens' DescribeVirtualRouter Text Source #

The name of the virtual router to describe.

ListMeshes

listMeshes_nextToken :: Lens' ListMeshes (Maybe Text) Source #

The nextToken value returned from a previous paginated ListMeshes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

listMeshes_limit :: Lens' ListMeshes (Maybe Natural) Source #

The maximum number of results returned by ListMeshes in paginated output. When you use this parameter, ListMeshes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListMeshes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListMeshes returns up to 100 results and a nextToken value if applicable.

listMeshesResponse_nextToken :: Lens' ListMeshesResponse (Maybe Text) Source #

The nextToken value to include in a future ListMeshes request. When the results of a ListMeshes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listMeshesResponse_meshes :: Lens' ListMeshesResponse [MeshRef] Source #

The list of existing service meshes.

CreateMesh

createMesh_clientToken :: Lens' CreateMesh (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createMesh_spec :: Lens' CreateMesh (Maybe MeshSpec) Source #

The service mesh specification to apply.

createMesh_tags :: Lens' CreateMesh (Maybe [TagRef]) Source #

Optional metadata that you can apply to the service mesh to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createMesh_meshName :: Lens' CreateMesh Text Source #

The name to use for the service mesh.

createMeshResponse_mesh :: Lens' CreateMeshResponse MeshData Source #

The full description of your service mesh following the create call.

UpdateMesh

updateMesh_clientToken :: Lens' UpdateMesh (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateMesh_spec :: Lens' UpdateMesh (Maybe MeshSpec) Source #

The service mesh specification to apply.

updateMesh_meshName :: Lens' UpdateMesh Text Source #

The name of the service mesh to update.

DeleteMesh

deleteMesh_meshName :: Lens' DeleteMesh Text Source #

The name of the service mesh to delete.

deleteMeshResponse_mesh :: Lens' DeleteMeshResponse MeshData Source #

The service mesh that was deleted.

ListTagsForResource

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

The nextToken value returned from a previous paginated ListTagsForResource request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listTagsForResource_limit :: Lens' ListTagsForResource (Maybe Natural) Source #

The maximum number of tag results returned by ListTagsForResource in paginated output. When this parameter is used, ListTagsForResource returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListTagsForResource request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListTagsForResource returns up to 100 results and a nextToken value if applicable.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource to list the tags for.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The nextToken value to include in a future ListTagsForResource request. When the results of a ListTagsForResource request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

CreateVirtualGateway

createVirtualGateway_clientToken :: Lens' CreateVirtualGateway (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createVirtualGateway_meshOwner :: Lens' CreateVirtualGateway (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createVirtualGateway_tags :: Lens' CreateVirtualGateway (Maybe [TagRef]) Source #

Optional metadata that you can apply to the virtual gateway to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createVirtualGateway_meshName :: Lens' CreateVirtualGateway Text Source #

The name of the service mesh to create the virtual gateway in.

createVirtualGateway_spec :: Lens' CreateVirtualGateway VirtualGatewaySpec Source #

The virtual gateway specification to apply.

createVirtualGatewayResponse_virtualGateway :: Lens' CreateVirtualGatewayResponse VirtualGatewayData Source #

The full description of your virtual gateway following the create call.

ListVirtualServices

listVirtualServices_meshOwner :: Lens' ListVirtualServices (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listVirtualServices_nextToken :: Lens' ListVirtualServices (Maybe Text) Source #

The nextToken value returned from a previous paginated ListVirtualServices request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listVirtualServices_limit :: Lens' ListVirtualServices (Maybe Natural) Source #

The maximum number of results returned by ListVirtualServices in paginated output. When you use this parameter, ListVirtualServices returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualServices request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualServices returns up to 100 results and a nextToken value if applicable.

listVirtualServices_meshName :: Lens' ListVirtualServices Text Source #

The name of the service mesh to list virtual services in.

listVirtualServicesResponse_nextToken :: Lens' ListVirtualServicesResponse (Maybe Text) Source #

The nextToken value to include in a future ListVirtualServices request. When the results of a ListVirtualServices request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listVirtualServicesResponse_virtualServices :: Lens' ListVirtualServicesResponse [VirtualServiceRef] Source #

The list of existing virtual services for the specified service mesh.

DeleteVirtualService

deleteVirtualService_meshOwner :: Lens' DeleteVirtualService (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteVirtualService_meshName :: Lens' DeleteVirtualService Text Source #

The name of the service mesh to delete the virtual service in.

deleteVirtualService_virtualServiceName :: Lens' DeleteVirtualService Text Source #

The name of the virtual service to delete.

UpdateVirtualService

updateVirtualService_clientToken :: Lens' UpdateVirtualService (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateVirtualService_meshOwner :: Lens' UpdateVirtualService (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateVirtualService_meshName :: Lens' UpdateVirtualService Text Source #

The name of the service mesh that the virtual service resides in.

updateVirtualService_spec :: Lens' UpdateVirtualService VirtualServiceSpec Source #

The new virtual service specification to apply. This overwrites the existing data.

updateVirtualService_virtualServiceName :: Lens' UpdateVirtualService Text Source #

The name of the virtual service to update.

UpdateVirtualGateway

updateVirtualGateway_clientToken :: Lens' UpdateVirtualGateway (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateVirtualGateway_meshOwner :: Lens' UpdateVirtualGateway (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateVirtualGateway_meshName :: Lens' UpdateVirtualGateway Text Source #

The name of the service mesh that the virtual gateway resides in.

updateVirtualGateway_spec :: Lens' UpdateVirtualGateway VirtualGatewaySpec Source #

The new virtual gateway specification to apply. This overwrites the existing data.

updateVirtualGateway_virtualGatewayName :: Lens' UpdateVirtualGateway Text Source #

The name of the virtual gateway to update.

DeleteVirtualGateway

deleteVirtualGateway_meshOwner :: Lens' DeleteVirtualGateway (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteVirtualGateway_meshName :: Lens' DeleteVirtualGateway Text Source #

The name of the service mesh to delete the virtual gateway from.

deleteVirtualGateway_virtualGatewayName :: Lens' DeleteVirtualGateway Text Source #

The name of the virtual gateway to delete.

DeleteRoute

deleteRoute_meshOwner :: Lens' DeleteRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteRoute_meshName :: Lens' DeleteRoute Text Source #

The name of the service mesh to delete the route in.

deleteRoute_routeName :: Lens' DeleteRoute Text Source #

The name of the route to delete.

deleteRoute_virtualRouterName :: Lens' DeleteRoute Text Source #

The name of the virtual router to delete the route in.

UpdateRoute

updateRoute_clientToken :: Lens' UpdateRoute (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateRoute_meshOwner :: Lens' UpdateRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateRoute_meshName :: Lens' UpdateRoute Text Source #

The name of the service mesh that the route resides in.

updateRoute_routeName :: Lens' UpdateRoute Text Source #

The name of the route to update.

updateRoute_spec :: Lens' UpdateRoute RouteSpec Source #

The new route specification to apply. This overwrites the existing data.

updateRoute_virtualRouterName :: Lens' UpdateRoute Text Source #

The name of the virtual router that the route is associated with.

updateRouteResponse_route :: Lens' UpdateRouteResponse RouteData Source #

A full description of the route that was updated.

CreateVirtualService

createVirtualService_clientToken :: Lens' CreateVirtualService (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createVirtualService_meshOwner :: Lens' CreateVirtualService (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createVirtualService_tags :: Lens' CreateVirtualService (Maybe [TagRef]) Source #

Optional metadata that you can apply to the virtual service to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createVirtualService_meshName :: Lens' CreateVirtualService Text Source #

The name of the service mesh to create the virtual service in.

createVirtualService_spec :: Lens' CreateVirtualService VirtualServiceSpec Source #

The virtual service specification to apply.

createVirtualServiceResponse_virtualService :: Lens' CreateVirtualServiceResponse VirtualServiceData Source #

The full description of your virtual service following the create call.

DeleteVirtualNode

deleteVirtualNode_meshOwner :: Lens' DeleteVirtualNode (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteVirtualNode_meshName :: Lens' DeleteVirtualNode Text Source #

The name of the service mesh to delete the virtual node in.

deleteVirtualNode_virtualNodeName :: Lens' DeleteVirtualNode Text Source #

The name of the virtual node to delete.

UpdateVirtualNode

updateVirtualNode_clientToken :: Lens' UpdateVirtualNode (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateVirtualNode_meshOwner :: Lens' UpdateVirtualNode (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateVirtualNode_meshName :: Lens' UpdateVirtualNode Text Source #

The name of the service mesh that the virtual node resides in.

updateVirtualNode_spec :: Lens' UpdateVirtualNode VirtualNodeSpec Source #

The new virtual node specification to apply. This overwrites the existing data.

updateVirtualNode_virtualNodeName :: Lens' UpdateVirtualNode Text Source #

The name of the virtual node to update.

updateVirtualNodeResponse_virtualNode :: Lens' UpdateVirtualNodeResponse VirtualNodeData Source #

A full description of the virtual node that was updated.

ListGatewayRoutes

listGatewayRoutes_meshOwner :: Lens' ListGatewayRoutes (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listGatewayRoutes_nextToken :: Lens' ListGatewayRoutes (Maybe Text) Source #

The nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listGatewayRoutes_limit :: Lens' ListGatewayRoutes (Maybe Natural) Source #

The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.

listGatewayRoutes_meshName :: Lens' ListGatewayRoutes Text Source #

The name of the service mesh to list gateway routes in.

listGatewayRoutes_virtualGatewayName :: Lens' ListGatewayRoutes Text Source #

The name of the virtual gateway to list gateway routes in.

listGatewayRoutesResponse_nextToken :: Lens' ListGatewayRoutesResponse (Maybe Text) Source #

The nextToken value to include in a future ListGatewayRoutes request. When the results of a ListGatewayRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listGatewayRoutesResponse_gatewayRoutes :: Lens' ListGatewayRoutesResponse [GatewayRouteRef] Source #

The list of existing gateway routes for the specified service mesh and virtual gateway.

ListRoutes

listRoutes_meshOwner :: Lens' ListRoutes (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listRoutes_nextToken :: Lens' ListRoutes (Maybe Text) Source #

The nextToken value returned from a previous paginated ListRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listRoutes_limit :: Lens' ListRoutes (Maybe Natural) Source #

The maximum number of results returned by ListRoutes in paginated output. When you use this parameter, ListRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListRoutes returns up to 100 results and a nextToken value if applicable.

listRoutes_meshName :: Lens' ListRoutes Text Source #

The name of the service mesh to list routes in.

listRoutes_virtualRouterName :: Lens' ListRoutes Text Source #

The name of the virtual router to list routes in.

listRoutesResponse_nextToken :: Lens' ListRoutesResponse (Maybe Text) Source #

The nextToken value to include in a future ListRoutes request. When the results of a ListRoutes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listRoutesResponse_routes :: Lens' ListRoutesResponse [RouteRef] Source #

The list of existing routes for the specified service mesh and virtual router.

ListVirtualNodes

listVirtualNodes_meshOwner :: Lens' ListVirtualNodes (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listVirtualNodes_nextToken :: Lens' ListVirtualNodes (Maybe Text) Source #

The nextToken value returned from a previous paginated ListVirtualNodes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listVirtualNodes_limit :: Lens' ListVirtualNodes (Maybe Natural) Source #

The maximum number of results returned by ListVirtualNodes in paginated output. When you use this parameter, ListVirtualNodes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualNodes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualNodes returns up to 100 results and a nextToken value if applicable.

listVirtualNodes_meshName :: Lens' ListVirtualNodes Text Source #

The name of the service mesh to list virtual nodes in.

listVirtualNodesResponse_nextToken :: Lens' ListVirtualNodesResponse (Maybe Text) Source #

The nextToken value to include in a future ListVirtualNodes request. When the results of a ListVirtualNodes request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listVirtualNodesResponse_virtualNodes :: Lens' ListVirtualNodesResponse [VirtualNodeRef] Source #

The list of existing virtual nodes for the specified service mesh.

DeleteVirtualRouter

deleteVirtualRouter_meshOwner :: Lens' DeleteVirtualRouter (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteVirtualRouter_meshName :: Lens' DeleteVirtualRouter Text Source #

The name of the service mesh to delete the virtual router in.

deleteVirtualRouter_virtualRouterName :: Lens' DeleteVirtualRouter Text Source #

The name of the virtual router to delete.

UpdateVirtualRouter

updateVirtualRouter_clientToken :: Lens' UpdateVirtualRouter (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateVirtualRouter_meshOwner :: Lens' UpdateVirtualRouter (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateVirtualRouter_meshName :: Lens' UpdateVirtualRouter Text Source #

The name of the service mesh that the virtual router resides in.

updateVirtualRouter_spec :: Lens' UpdateVirtualRouter VirtualRouterSpec Source #

The new virtual router specification to apply. This overwrites the existing data.

updateVirtualRouter_virtualRouterName :: Lens' UpdateVirtualRouter Text Source #

The name of the virtual router to update.

updateVirtualRouterResponse_virtualRouter :: Lens' UpdateVirtualRouterResponse VirtualRouterData Source #

A full description of the virtual router that was updated.

CreateVirtualRouter

createVirtualRouter_clientToken :: Lens' CreateVirtualRouter (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createVirtualRouter_meshOwner :: Lens' CreateVirtualRouter (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createVirtualRouter_tags :: Lens' CreateVirtualRouter (Maybe [TagRef]) Source #

Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createVirtualRouter_meshName :: Lens' CreateVirtualRouter Text Source #

The name of the service mesh to create the virtual router in.

createVirtualRouter_spec :: Lens' CreateVirtualRouter VirtualRouterSpec Source #

The virtual router specification to apply.

createVirtualRouterResponse_virtualRouter :: Lens' CreateVirtualRouterResponse VirtualRouterData Source #

The full description of your virtual router following the create call.

DescribeVirtualService

describeVirtualService_meshOwner :: Lens' DescribeVirtualService (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeVirtualService_meshName :: Lens' DescribeVirtualService Text Source #

The name of the service mesh that the virtual service resides in.

DescribeGatewayRoute

describeGatewayRoute_meshOwner :: Lens' DescribeGatewayRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeGatewayRoute_gatewayRouteName :: Lens' DescribeGatewayRoute Text Source #

The name of the gateway route to describe.

describeGatewayRoute_meshName :: Lens' DescribeGatewayRoute Text Source #

The name of the service mesh that the gateway route resides in.

describeGatewayRoute_virtualGatewayName :: Lens' DescribeGatewayRoute Text Source #

The name of the virtual gateway that the gateway route is associated with.

CreateRoute

createRoute_clientToken :: Lens' CreateRoute (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createRoute_meshOwner :: Lens' CreateRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createRoute_tags :: Lens' CreateRoute (Maybe [TagRef]) Source #

Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createRoute_meshName :: Lens' CreateRoute Text Source #

The name of the service mesh to create the route in.

createRoute_routeName :: Lens' CreateRoute Text Source #

The name to use for the route.

createRoute_spec :: Lens' CreateRoute RouteSpec Source #

The route specification to apply.

createRoute_virtualRouterName :: Lens' CreateRoute Text Source #

The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

createRouteResponse_route :: Lens' CreateRouteResponse RouteData Source #

The full description of your mesh following the create call.

CreateVirtualNode

createVirtualNode_clientToken :: Lens' CreateVirtualNode (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createVirtualNode_meshOwner :: Lens' CreateVirtualNode (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createVirtualNode_tags :: Lens' CreateVirtualNode (Maybe [TagRef]) Source #

Optional metadata that you can apply to the virtual node to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createVirtualNode_meshName :: Lens' CreateVirtualNode Text Source #

The name of the service mesh to create the virtual node in.

createVirtualNode_spec :: Lens' CreateVirtualNode VirtualNodeSpec Source #

The virtual node specification to apply.

createVirtualNode_virtualNodeName :: Lens' CreateVirtualNode Text Source #

The name to use for the virtual node.

createVirtualNodeResponse_virtualNode :: Lens' CreateVirtualNodeResponse VirtualNodeData Source #

The full description of your virtual node following the create call.

CreateGatewayRoute

createGatewayRoute_clientToken :: Lens' CreateGatewayRoute (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

createGatewayRoute_meshOwner :: Lens' CreateGatewayRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

createGatewayRoute_tags :: Lens' CreateGatewayRoute (Maybe [TagRef]) Source #

Optional metadata that you can apply to the gateway route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

createGatewayRoute_gatewayRouteName :: Lens' CreateGatewayRoute Text Source #

The name to use for the gateway route.

createGatewayRoute_meshName :: Lens' CreateGatewayRoute Text Source #

The name of the service mesh to create the gateway route in.

createGatewayRoute_spec :: Lens' CreateGatewayRoute GatewayRouteSpec Source #

The gateway route specification to apply.

createGatewayRoute_virtualGatewayName :: Lens' CreateGatewayRoute Text Source #

The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.

createGatewayRouteResponse_gatewayRoute :: Lens' CreateGatewayRouteResponse GatewayRouteData Source #

The full description of your gateway route following the create call.

UpdateGatewayRoute

updateGatewayRoute_clientToken :: Lens' UpdateGatewayRoute (Maybe Text) Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

updateGatewayRoute_meshOwner :: Lens' UpdateGatewayRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

updateGatewayRoute_gatewayRouteName :: Lens' UpdateGatewayRoute Text Source #

The name of the gateway route to update.

updateGatewayRoute_meshName :: Lens' UpdateGatewayRoute Text Source #

The name of the service mesh that the gateway route resides in.

updateGatewayRoute_spec :: Lens' UpdateGatewayRoute GatewayRouteSpec Source #

The new gateway route specification to apply. This overwrites the existing data.

updateGatewayRoute_virtualGatewayName :: Lens' UpdateGatewayRoute Text Source #

The name of the virtual gateway that the gateway route is associated with.

updateGatewayRouteResponse_gatewayRoute :: Lens' UpdateGatewayRouteResponse GatewayRouteData Source #

A full description of the gateway route that was updated.

DeleteGatewayRoute

deleteGatewayRoute_meshOwner :: Lens' DeleteGatewayRoute (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

deleteGatewayRoute_gatewayRouteName :: Lens' DeleteGatewayRoute Text Source #

The name of the gateway route to delete.

deleteGatewayRoute_meshName :: Lens' DeleteGatewayRoute Text Source #

The name of the service mesh to delete the gateway route from.

deleteGatewayRoute_virtualGatewayName :: Lens' DeleteGatewayRoute Text Source #

The name of the virtual gateway to delete the route from.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the resource to add tags to.

tagResource_tags :: Lens' TagResource [TagRef] Source #

The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

ListVirtualGateways

listVirtualGateways_meshOwner :: Lens' ListVirtualGateways (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listVirtualGateways_nextToken :: Lens' ListVirtualGateways (Maybe Text) Source #

The nextToken value returned from a previous paginated ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listVirtualGateways_limit :: Lens' ListVirtualGateways (Maybe Natural) Source #

The maximum number of results returned by ListVirtualGateways in paginated output. When you use this parameter, ListVirtualGateways returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.

listVirtualGateways_meshName :: Lens' ListVirtualGateways Text Source #

The name of the service mesh to list virtual gateways in.

listVirtualGatewaysResponse_nextToken :: Lens' ListVirtualGatewaysResponse (Maybe Text) Source #

The nextToken value to include in a future ListVirtualGateways request. When the results of a ListVirtualGateways request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listVirtualGatewaysResponse_virtualGateways :: Lens' ListVirtualGatewaysResponse [VirtualGatewayRef] Source #

The list of existing virtual gateways for the specified service mesh.

ListVirtualRouters

listVirtualRouters_meshOwner :: Lens' ListVirtualRouters (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

listVirtualRouters_nextToken :: Lens' ListVirtualRouters (Maybe Text) Source #

The nextToken value returned from a previous paginated ListVirtualRouters request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

listVirtualRouters_limit :: Lens' ListVirtualRouters (Maybe Natural) Source #

The maximum number of results returned by ListVirtualRouters in paginated output. When you use this parameter, ListVirtualRouters returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualRouters request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualRouters returns up to 100 results and a nextToken value if applicable.

listVirtualRouters_meshName :: Lens' ListVirtualRouters Text Source #

The name of the service mesh to list virtual routers in.

listVirtualRoutersResponse_nextToken :: Lens' ListVirtualRoutersResponse (Maybe Text) Source #

The nextToken value to include in a future ListVirtualRouters request. When the results of a ListVirtualRouters request exceed limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

listVirtualRoutersResponse_virtualRouters :: Lens' ListVirtualRoutersResponse [VirtualRouterRef] Source #

The list of existing virtual routers for the specified service mesh.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the resource to delete tags from.

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The keys of the tags to be removed.

DescribeMesh

describeMesh_meshOwner :: Lens' DescribeMesh (Maybe Text) Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

describeMesh_meshName :: Lens' DescribeMesh Text Source #

The name of the service mesh to describe.

describeMeshResponse_mesh :: Lens' DescribeMeshResponse MeshData Source #

The full description of your service mesh.

Types

AccessLog

accessLog_file :: Lens' AccessLog (Maybe FileAccessLog) Source #

The file object to send virtual node access logs to.

AwsCloudMapInstanceAttribute

awsCloudMapInstanceAttribute_key :: Lens' AwsCloudMapInstanceAttribute Text Source #

The name of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

awsCloudMapInstanceAttribute_value :: Lens' AwsCloudMapInstanceAttribute Text Source #

The value of an Cloud Map service instance attribute key. Any Cloud Map service instance that contains the specified key and value is returned.

AwsCloudMapServiceDiscovery

awsCloudMapServiceDiscovery_attributes :: Lens' AwsCloudMapServiceDiscovery (Maybe [AwsCloudMapInstanceAttribute]) Source #

A string map that contains attributes with values that you can use to filter instances by any custom attribute that you specified when you registered the instance. Only instances that match all of the specified key/value pairs will be returned.

Backend

backend_virtualService :: Lens' Backend (Maybe VirtualServiceBackend) Source #

Specifies a virtual service to use as a backend.

BackendDefaults

backendDefaults_clientPolicy :: Lens' BackendDefaults (Maybe ClientPolicy) Source #

A reference to an object that represents a client policy.

ClientPolicy

clientPolicy_tls :: Lens' ClientPolicy (Maybe ClientPolicyTls) Source #

A reference to an object that represents a Transport Layer Security (TLS) client policy.

ClientPolicyTls

clientPolicyTls_ports :: Lens' ClientPolicyTls (Maybe [Natural]) Source #

One or more ports that the policy is enforced for.

clientPolicyTls_certificate :: Lens' ClientPolicyTls (Maybe ClientTlsCertificate) Source #

A reference to an object that represents a client's TLS certificate.

clientPolicyTls_enforce :: Lens' ClientPolicyTls (Maybe Bool) Source #

Whether the policy is enforced. The default is True, if a value isn't specified.

clientPolicyTls_validation :: Lens' ClientPolicyTls TlsValidationContext Source #

A reference to an object that represents a TLS validation context.

ClientTlsCertificate

clientTlsCertificate_sds :: Lens' ClientTlsCertificate (Maybe ListenerTlsSdsCertificate) Source #

A reference to an object that represents a client's TLS Secret Discovery Service certificate.

clientTlsCertificate_file :: Lens' ClientTlsCertificate (Maybe ListenerTlsFileCertificate) Source #

An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

DnsServiceDiscovery

dnsServiceDiscovery_responseType :: Lens' DnsServiceDiscovery (Maybe DnsResponseType) Source #

Specifies the DNS response type for the virtual node.

dnsServiceDiscovery_hostname :: Lens' DnsServiceDiscovery Text Source #

Specifies the DNS service discovery hostname for the virtual node.

Duration

duration_value :: Lens' Duration (Maybe Natural) Source #

A number of time units.

EgressFilter

egressFilter_type :: Lens' EgressFilter EgressFilterType Source #

The egress filter type. By default, the type is DROP_ALL, which allows egress only from virtual nodes to other defined resources in the service mesh (and any traffic to *.amazonaws.com for Amazon Web Services API calls). You can set the egress filter type to ALLOW_ALL to allow egress to any endpoint inside or outside of the service mesh.

FileAccessLog

fileAccessLog_path :: Lens' FileAccessLog Text Source #

The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

The Envoy process must have write permissions to the path that you specify here. Otherwise, Envoy fails to bootstrap properly.

GatewayRouteData

gatewayRouteData_meshName :: Lens' GatewayRouteData Text Source #

The name of the service mesh that the resource resides in.

gatewayRouteData_spec :: Lens' GatewayRouteData GatewayRouteSpec Source #

The specifications of the gateway route.

gatewayRouteData_virtualGatewayName :: Lens' GatewayRouteData Text Source #

The virtual gateway that the gateway route is associated with.

GatewayRouteHostnameMatch

gatewayRouteHostnameMatch_suffix :: Lens' GatewayRouteHostnameMatch (Maybe Text) Source #

The specified ending characters of the host name to match on.

GatewayRouteHostnameRewrite

GatewayRouteRef

gatewayRouteRef_arn :: Lens' GatewayRouteRef Text Source #

The full Amazon Resource Name (ARN) for the gateway route.

gatewayRouteRef_createdAt :: Lens' GatewayRouteRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

gatewayRouteRef_lastUpdatedAt :: Lens' GatewayRouteRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

gatewayRouteRef_meshName :: Lens' GatewayRouteRef Text Source #

The name of the service mesh that the resource resides in.

gatewayRouteRef_meshOwner :: Lens' GatewayRouteRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

gatewayRouteRef_resourceOwner :: Lens' GatewayRouteRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

gatewayRouteRef_version :: Lens' GatewayRouteRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

gatewayRouteRef_virtualGatewayName :: Lens' GatewayRouteRef Text Source #

The virtual gateway that the gateway route is associated with.

GatewayRouteSpec

gatewayRouteSpec_priority :: Lens' GatewayRouteSpec (Maybe Natural) Source #

The ordering of the gateway routes spec.

gatewayRouteSpec_http2Route :: Lens' GatewayRouteSpec (Maybe HttpGatewayRoute) Source #

An object that represents the specification of an HTTP/2 gateway route.

gatewayRouteSpec_grpcRoute :: Lens' GatewayRouteSpec (Maybe GrpcGatewayRoute) Source #

An object that represents the specification of a gRPC gateway route.

gatewayRouteSpec_httpRoute :: Lens' GatewayRouteSpec (Maybe HttpGatewayRoute) Source #

An object that represents the specification of an HTTP gateway route.

GatewayRouteStatus

GatewayRouteTarget

gatewayRouteTarget_virtualService :: Lens' GatewayRouteTarget GatewayRouteVirtualService Source #

An object that represents a virtual service gateway route target.

GatewayRouteVirtualService

gatewayRouteVirtualService_virtualServiceName :: Lens' GatewayRouteVirtualService Text Source #

The name of the virtual service that traffic is routed to.

GrpcGatewayRoute

grpcGatewayRoute_action :: Lens' GrpcGatewayRoute GrpcGatewayRouteAction Source #

An object that represents the action to take if a match is determined.

grpcGatewayRoute_match :: Lens' GrpcGatewayRoute GrpcGatewayRouteMatch Source #

An object that represents the criteria for determining a request match.

GrpcGatewayRouteAction

grpcGatewayRouteAction_target :: Lens' GrpcGatewayRouteAction GatewayRouteTarget Source #

An object that represents the target that traffic is routed to when a request matches the gateway route.

GrpcGatewayRouteMatch

grpcGatewayRouteMatch_serviceName :: Lens' GrpcGatewayRouteMatch (Maybe Text) Source #

The fully qualified domain name for the service to match from the request.

GrpcGatewayRouteMetadata

grpcGatewayRouteMetadata_invert :: Lens' GrpcGatewayRouteMetadata (Maybe Bool) Source #

Specify True to match anything except the match criteria. The default value is False.

grpcGatewayRouteMetadata_name :: Lens' GrpcGatewayRouteMetadata Text Source #

A name for the gateway route metadata.

GrpcGatewayRouteRewrite

GrpcMetadataMatchMethod

grpcMetadataMatchMethod_suffix :: Lens' GrpcMetadataMatchMethod (Maybe Text) Source #

The specified ending characters of the method header to match on.

grpcMetadataMatchMethod_regex :: Lens' GrpcMetadataMatchMethod (Maybe Text) Source #

The regex used to match the method header.

grpcMetadataMatchMethod_prefix :: Lens' GrpcMetadataMatchMethod (Maybe Text) Source #

The specified beginning characters of the method header to be matched on.

grpcMetadataMatchMethod_exact :: Lens' GrpcMetadataMatchMethod (Maybe Text) Source #

The exact method header to be matched on.

GrpcRetryPolicy

grpcRetryPolicy_httpRetryEvents :: Lens' GrpcRetryPolicy (Maybe (NonEmpty Text)) Source #

Specify at least one of the following values.

  • server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
  • gateway-error – HTTP status codes 502, 503, and 504
  • client-error – HTTP status code 409
  • stream-error – Retry on refused stream

grpcRetryPolicy_tcpRetryEvents :: Lens' GrpcRetryPolicy (Maybe (NonEmpty TcpRetryPolicyEvent)) Source #

Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

grpcRetryPolicy_maxRetries :: Lens' GrpcRetryPolicy Natural Source #

The maximum number of retry attempts.

GrpcRoute

grpcRoute_retryPolicy :: Lens' GrpcRoute (Maybe GrpcRetryPolicy) Source #

An object that represents a retry policy.

grpcRoute_timeout :: Lens' GrpcRoute (Maybe GrpcTimeout) Source #

An object that represents types of timeouts.

grpcRoute_action :: Lens' GrpcRoute GrpcRouteAction Source #

An object that represents the action to take if a match is determined.

grpcRoute_match :: Lens' GrpcRoute GrpcRouteMatch Source #

An object that represents the criteria for determining a request match.

GrpcRouteAction

grpcRouteAction_weightedTargets :: Lens' GrpcRouteAction (NonEmpty WeightedTarget) Source #

An object that represents the targets that traffic is routed to when a request matches the route.

GrpcRouteMatch

grpcRouteMatch_methodName :: Lens' GrpcRouteMatch (Maybe Text) Source #

The method name to match from the request. If you specify a name, you must also specify a serviceName.

grpcRouteMatch_serviceName :: Lens' GrpcRouteMatch (Maybe Text) Source #

The fully qualified domain name for the service to match from the request.

grpcRouteMatch_metadata :: Lens' GrpcRouteMatch (Maybe (NonEmpty GrpcRouteMetadata)) Source #

An object that represents the data to match from the request.

GrpcRouteMetadata

grpcRouteMetadata_invert :: Lens' GrpcRouteMetadata (Maybe Bool) Source #

Specify True to match anything except the match criteria. The default value is False.

grpcRouteMetadata_match :: Lens' GrpcRouteMetadata (Maybe GrpcRouteMetadataMatchMethod) Source #

An object that represents the data to match from the request.

GrpcRouteMetadataMatchMethod

grpcRouteMetadataMatchMethod_suffix :: Lens' GrpcRouteMetadataMatchMethod (Maybe Text) Source #

The value sent by the client must end with the specified characters.

grpcRouteMetadataMatchMethod_regex :: Lens' GrpcRouteMetadataMatchMethod (Maybe Text) Source #

The value sent by the client must include the specified characters.

grpcRouteMetadataMatchMethod_prefix :: Lens' GrpcRouteMetadataMatchMethod (Maybe Text) Source #

The value sent by the client must begin with the specified characters.

grpcRouteMetadataMatchMethod_range :: Lens' GrpcRouteMetadataMatchMethod (Maybe MatchRange) Source #

An object that represents the range of values to match on.

grpcRouteMetadataMatchMethod_exact :: Lens' GrpcRouteMetadataMatchMethod (Maybe Text) Source #

The value sent by the client must match the specified value exactly.

GrpcTimeout

grpcTimeout_idle :: Lens' GrpcTimeout (Maybe Duration) Source #

An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

grpcTimeout_perRequest :: Lens' GrpcTimeout (Maybe Duration) Source #

An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

HeaderMatchMethod

headerMatchMethod_suffix :: Lens' HeaderMatchMethod (Maybe Text) Source #

The value sent by the client must end with the specified characters.

headerMatchMethod_regex :: Lens' HeaderMatchMethod (Maybe Text) Source #

The value sent by the client must include the specified characters.

headerMatchMethod_prefix :: Lens' HeaderMatchMethod (Maybe Text) Source #

The value sent by the client must begin with the specified characters.

headerMatchMethod_range :: Lens' HeaderMatchMethod (Maybe MatchRange) Source #

An object that represents the range of values to match on.

headerMatchMethod_exact :: Lens' HeaderMatchMethod (Maybe Text) Source #

The value sent by the client must match the specified value exactly.

HealthCheckPolicy

healthCheckPolicy_path :: Lens' HealthCheckPolicy (Maybe Text) Source #

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

healthCheckPolicy_port :: Lens' HealthCheckPolicy (Maybe Natural) Source #

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

healthCheckPolicy_healthyThreshold :: Lens' HealthCheckPolicy Natural Source #

The number of consecutive successful health checks that must occur before declaring listener healthy.

healthCheckPolicy_intervalMillis :: Lens' HealthCheckPolicy Natural Source #

The time period in milliseconds between each health check execution.

healthCheckPolicy_protocol :: Lens' HealthCheckPolicy PortProtocol Source #

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

healthCheckPolicy_timeoutMillis :: Lens' HealthCheckPolicy Natural Source #

The amount of time to wait when receiving a response from the health check, in milliseconds.

healthCheckPolicy_unhealthyThreshold :: Lens' HealthCheckPolicy Natural Source #

The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.

HttpGatewayRoute

httpGatewayRoute_action :: Lens' HttpGatewayRoute HttpGatewayRouteAction Source #

An object that represents the action to take if a match is determined.

httpGatewayRoute_match :: Lens' HttpGatewayRoute HttpGatewayRouteMatch Source #

An object that represents the criteria for determining a request match.

HttpGatewayRouteAction

httpGatewayRouteAction_target :: Lens' HttpGatewayRouteAction GatewayRouteTarget Source #

An object that represents the target that traffic is routed to when a request matches the gateway route.

HttpGatewayRouteHeader

httpGatewayRouteHeader_invert :: Lens' HttpGatewayRouteHeader (Maybe Bool) Source #

Specify True to match anything except the match criteria. The default value is False.

httpGatewayRouteHeader_name :: Lens' HttpGatewayRouteHeader Text Source #

A name for the HTTP header in the gateway route that will be matched on.

HttpGatewayRouteMatch

httpGatewayRouteMatch_prefix :: Lens' HttpGatewayRouteMatch (Maybe Text) Source #

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

HttpGatewayRoutePathRewrite

HttpGatewayRoutePrefixRewrite

httpGatewayRoutePrefixRewrite_value :: Lens' HttpGatewayRoutePrefixRewrite (Maybe Text) Source #

The value used to replace the incoming route prefix when rewritten.

httpGatewayRoutePrefixRewrite_defaultPrefix :: Lens' HttpGatewayRoutePrefixRewrite (Maybe DefaultGatewayRouteRewrite) Source #

The default prefix used to replace the incoming route prefix when rewritten.

HttpGatewayRouteRewrite

HttpPathMatch

httpPathMatch_regex :: Lens' HttpPathMatch (Maybe Text) Source #

The regex used to match the path.

httpPathMatch_exact :: Lens' HttpPathMatch (Maybe Text) Source #

The exact path to match on.

HttpQueryParameter

httpQueryParameter_name :: Lens' HttpQueryParameter Text Source #

A name for the query parameter that will be matched on.

HttpRetryPolicy

httpRetryPolicy_httpRetryEvents :: Lens' HttpRetryPolicy (Maybe (NonEmpty Text)) Source #

Specify at least one of the following values.

  • server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
  • gateway-error – HTTP status codes 502, 503, and 504
  • client-error – HTTP status code 409
  • stream-error – Retry on refused stream

httpRetryPolicy_tcpRetryEvents :: Lens' HttpRetryPolicy (Maybe (NonEmpty TcpRetryPolicyEvent)) Source #

Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

httpRetryPolicy_maxRetries :: Lens' HttpRetryPolicy Natural Source #

The maximum number of retry attempts.

HttpRoute

httpRoute_retryPolicy :: Lens' HttpRoute (Maybe HttpRetryPolicy) Source #

An object that represents a retry policy.

httpRoute_timeout :: Lens' HttpRoute (Maybe HttpTimeout) Source #

An object that represents types of timeouts.

httpRoute_action :: Lens' HttpRoute HttpRouteAction Source #

An object that represents the action to take if a match is determined.

httpRoute_match :: Lens' HttpRoute HttpRouteMatch Source #

An object that represents the criteria for determining a request match.

HttpRouteAction

httpRouteAction_weightedTargets :: Lens' HttpRouteAction (NonEmpty WeightedTarget) Source #

An object that represents the targets that traffic is routed to when a request matches the route.

HttpRouteHeader

httpRouteHeader_invert :: Lens' HttpRouteHeader (Maybe Bool) Source #

Specify True to match anything except the match criteria. The default value is False.

httpRouteHeader_name :: Lens' HttpRouteHeader Text Source #

A name for the HTTP header in the client request that will be matched on.

HttpRouteMatch

httpRouteMatch_path :: Lens' HttpRouteMatch (Maybe HttpPathMatch) Source #

The client request path to match on.

httpRouteMatch_prefix :: Lens' HttpRouteMatch (Maybe Text) Source #

Specifies the path to match requests with. This parameter must always start with /, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

httpRouteMatch_queryParameters :: Lens' HttpRouteMatch (Maybe (NonEmpty HttpQueryParameter)) Source #

The client request query parameters to match on.

httpRouteMatch_headers :: Lens' HttpRouteMatch (Maybe (NonEmpty HttpRouteHeader)) Source #

The client request headers to match on.

httpRouteMatch_method :: Lens' HttpRouteMatch (Maybe HttpMethod) Source #

The client request method to match on. Specify only one.

httpRouteMatch_scheme :: Lens' HttpRouteMatch (Maybe HttpScheme) Source #

The client request scheme to match on. Specify only one. Applicable only for HTTP2 routes.

HttpTimeout

httpTimeout_idle :: Lens' HttpTimeout (Maybe Duration) Source #

An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

httpTimeout_perRequest :: Lens' HttpTimeout (Maybe Duration) Source #

An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

Listener

listener_healthCheck :: Lens' Listener (Maybe HealthCheckPolicy) Source #

The health check information for the listener.

listener_connectionPool :: Lens' Listener (Maybe VirtualNodeConnectionPool) Source #

The connection pool information for the listener.

listener_tls :: Lens' Listener (Maybe ListenerTls) Source #

A reference to an object that represents the Transport Layer Security (TLS) properties for a listener.

listener_outlierDetection :: Lens' Listener (Maybe OutlierDetection) Source #

The outlier detection information for the listener.

listener_timeout :: Lens' Listener (Maybe ListenerTimeout) Source #

An object that represents timeouts for different protocols.

listener_portMapping :: Lens' Listener PortMapping Source #

The port mapping information for the listener.

ListenerTimeout

listenerTimeout_http2 :: Lens' ListenerTimeout (Maybe HttpTimeout) Source #

An object that represents types of timeouts.

listenerTimeout_grpc :: Lens' ListenerTimeout (Maybe GrpcTimeout) Source #

An object that represents types of timeouts.

listenerTimeout_tcp :: Lens' ListenerTimeout (Maybe TcpTimeout) Source #

An object that represents types of timeouts.

listenerTimeout_http :: Lens' ListenerTimeout (Maybe HttpTimeout) Source #

An object that represents types of timeouts.

ListenerTls

listenerTls_validation :: Lens' ListenerTls (Maybe ListenerTlsValidationContext) Source #

A reference to an object that represents a listener's Transport Layer Security (TLS) validation context.

listenerTls_certificate :: Lens' ListenerTls ListenerTlsCertificate Source #

A reference to an object that represents a listener's Transport Layer Security (TLS) certificate.

listenerTls_mode :: Lens' ListenerTls ListenerTlsMode Source #

Specify one of the following modes.

  • ____STRICT – Listener only accepts connections with TLS enabled.
  • ____PERMISSIVE – Listener accepts connections with or without TLS enabled.
  • ____DISABLED – Listener only accepts connections without TLS.

ListenerTlsAcmCertificate

listenerTlsAcmCertificate_certificateArn :: Lens' ListenerTlsAcmCertificate Text Source #

The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

ListenerTlsCertificate

listenerTlsCertificate_acm :: Lens' ListenerTlsCertificate (Maybe ListenerTlsAcmCertificate) Source #

A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

listenerTlsCertificate_sds :: Lens' ListenerTlsCertificate (Maybe ListenerTlsSdsCertificate) Source #

A reference to an object that represents a listener's Secret Discovery Service certificate.

listenerTlsCertificate_file :: Lens' ListenerTlsCertificate (Maybe ListenerTlsFileCertificate) Source #

A reference to an object that represents a local file certificate.

ListenerTlsFileCertificate

listenerTlsFileCertificate_privateKey :: Lens' ListenerTlsFileCertificate Text Source #

The private key for a certificate stored on the file system of the virtual node that the proxy is running on.

ListenerTlsSdsCertificate

listenerTlsSdsCertificate_secretName :: Lens' ListenerTlsSdsCertificate Text Source #

A reference to an object that represents the name of the secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

ListenerTlsValidationContext

listenerTlsValidationContext_subjectAlternativeNames :: Lens' ListenerTlsValidationContext (Maybe SubjectAlternativeNames) Source #

A reference to an object that represents the SANs for a listener's Transport Layer Security (TLS) validation context.

listenerTlsValidationContext_trust :: Lens' ListenerTlsValidationContext ListenerTlsValidationContextTrust Source #

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

ListenerTlsValidationContextTrust

listenerTlsValidationContextTrust_sds :: Lens' ListenerTlsValidationContextTrust (Maybe TlsValidationContextSdsTrust) Source #

A reference to an object that represents a listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

listenerTlsValidationContextTrust_file :: Lens' ListenerTlsValidationContextTrust (Maybe TlsValidationContextFileTrust) Source #

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

Logging

logging_accessLog :: Lens' Logging (Maybe AccessLog) Source #

The access log configuration for a virtual node.

MatchRange

matchRange_end :: Lens' MatchRange Integer Source #

The end of the range.

matchRange_start :: Lens' MatchRange Integer Source #

The start of the range.

MeshData

meshData_meshName :: Lens' MeshData Text Source #

The name of the service mesh.

meshData_metadata :: Lens' MeshData ResourceMetadata Source #

The associated metadata for the service mesh.

meshData_spec :: Lens' MeshData MeshSpec Source #

The associated specification for the service mesh.

meshData_status :: Lens' MeshData MeshStatus Source #

The status of the service mesh.

MeshRef

meshRef_arn :: Lens' MeshRef Text Source #

The full Amazon Resource Name (ARN) of the service mesh.

meshRef_createdAt :: Lens' MeshRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

meshRef_lastUpdatedAt :: Lens' MeshRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

meshRef_meshName :: Lens' MeshRef Text Source #

The name of the service mesh.

meshRef_meshOwner :: Lens' MeshRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

meshRef_resourceOwner :: Lens' MeshRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

meshRef_version :: Lens' MeshRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

MeshSpec

meshSpec_egressFilter :: Lens' MeshSpec (Maybe EgressFilter) Source #

The egress filter rules for the service mesh.

MeshStatus

OutlierDetection

outlierDetection_baseEjectionDuration :: Lens' OutlierDetection Duration Source #

The base amount of time for which a host is ejected.

outlierDetection_interval :: Lens' OutlierDetection Duration Source #

The time interval between ejection sweep analysis.

outlierDetection_maxEjectionPercent :: Lens' OutlierDetection Natural Source #

Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value.

outlierDetection_maxServerErrors :: Lens' OutlierDetection Natural Source #

Number of consecutive 5xx errors required for ejection.

PortMapping

portMapping_port :: Lens' PortMapping Natural Source #

The port used for the port mapping.

portMapping_protocol :: Lens' PortMapping PortProtocol Source #

The protocol used for the port mapping. Specify one protocol.

QueryParameterMatch

queryParameterMatch_exact :: Lens' QueryParameterMatch (Maybe Text) Source #

The exact query parameter to match on.

ResourceMetadata

resourceMetadata_arn :: Lens' ResourceMetadata Text Source #

The full Amazon Resource Name (ARN) for the resource.

resourceMetadata_createdAt :: Lens' ResourceMetadata UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

resourceMetadata_lastUpdatedAt :: Lens' ResourceMetadata UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

resourceMetadata_meshOwner :: Lens' ResourceMetadata Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

resourceMetadata_resourceOwner :: Lens' ResourceMetadata Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

resourceMetadata_uid :: Lens' ResourceMetadata Text Source #

The unique identifier for the resource.

resourceMetadata_version :: Lens' ResourceMetadata Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

RouteData

routeData_meshName :: Lens' RouteData Text Source #

The name of the service mesh that the route resides in.

routeData_metadata :: Lens' RouteData ResourceMetadata Source #

The associated metadata for the route.

routeData_routeName :: Lens' RouteData Text Source #

The name of the route.

routeData_spec :: Lens' RouteData RouteSpec Source #

The specifications of the route.

routeData_status :: Lens' RouteData RouteStatus Source #

The status of the route.

routeData_virtualRouterName :: Lens' RouteData Text Source #

The virtual router that the route is associated with.

RouteRef

routeRef_arn :: Lens' RouteRef Text Source #

The full Amazon Resource Name (ARN) for the route.

routeRef_createdAt :: Lens' RouteRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

routeRef_lastUpdatedAt :: Lens' RouteRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

routeRef_meshName :: Lens' RouteRef Text Source #

The name of the service mesh that the route resides in.

routeRef_meshOwner :: Lens' RouteRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

routeRef_resourceOwner :: Lens' RouteRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

routeRef_routeName :: Lens' RouteRef Text Source #

The name of the route.

routeRef_version :: Lens' RouteRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

routeRef_virtualRouterName :: Lens' RouteRef Text Source #

The virtual router that the route is associated with.

RouteSpec

routeSpec_priority :: Lens' RouteSpec (Maybe Natural) Source #

The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.

routeSpec_http2Route :: Lens' RouteSpec (Maybe HttpRoute) Source #

An object that represents the specification of an HTTP/2 route.

routeSpec_grpcRoute :: Lens' RouteSpec (Maybe GrpcRoute) Source #

An object that represents the specification of a gRPC route.

routeSpec_tcpRoute :: Lens' RouteSpec (Maybe TcpRoute) Source #

An object that represents the specification of a TCP route.

routeSpec_httpRoute :: Lens' RouteSpec (Maybe HttpRoute) Source #

An object that represents the specification of an HTTP route.

RouteStatus

routeStatus_status :: Lens' RouteStatus RouteStatusCode Source #

The current status for the route.

ServiceDiscovery

serviceDiscovery_awsCloudMap :: Lens' ServiceDiscovery (Maybe AwsCloudMapServiceDiscovery) Source #

Specifies any Cloud Map information for the virtual node.

serviceDiscovery_dns :: Lens' ServiceDiscovery (Maybe DnsServiceDiscovery) Source #

Specifies the DNS information for the virtual node.

SubjectAlternativeNameMatchers

subjectAlternativeNameMatchers_exact :: Lens' SubjectAlternativeNameMatchers [Text] Source #

The values sent must match the specified values exactly.

SubjectAlternativeNames

subjectAlternativeNames_match :: Lens' SubjectAlternativeNames SubjectAlternativeNameMatchers Source #

An object that represents the criteria for determining a SANs match.

TagRef

tagRef_key :: Lens' TagRef Text Source #

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

tagRef_value :: Lens' TagRef Text Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

TcpRoute

tcpRoute_timeout :: Lens' TcpRoute (Maybe TcpTimeout) Source #

An object that represents types of timeouts.

tcpRoute_action :: Lens' TcpRoute TcpRouteAction Source #

The action to take if a match is determined.

TcpRouteAction

tcpRouteAction_weightedTargets :: Lens' TcpRouteAction (NonEmpty WeightedTarget) Source #

An object that represents the targets that traffic is routed to when a request matches the route.

TcpTimeout

tcpTimeout_idle :: Lens' TcpTimeout (Maybe Duration) Source #

An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

TlsValidationContext

tlsValidationContext_subjectAlternativeNames :: Lens' TlsValidationContext (Maybe SubjectAlternativeNames) Source #

A reference to an object that represents the SANs for a Transport Layer Security (TLS) validation context.

tlsValidationContext_trust :: Lens' TlsValidationContext TlsValidationContextTrust Source #

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

TlsValidationContextAcmTrust

TlsValidationContextFileTrust

tlsValidationContextFileTrust_certificateChain :: Lens' TlsValidationContextFileTrust Text Source #

The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

TlsValidationContextSdsTrust

tlsValidationContextSdsTrust_secretName :: Lens' TlsValidationContextSdsTrust Text Source #

A reference to an object that represents the name of the secret for a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

TlsValidationContextTrust

tlsValidationContextTrust_acm :: Lens' TlsValidationContextTrust (Maybe TlsValidationContextAcmTrust) Source #

A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

tlsValidationContextTrust_sds :: Lens' TlsValidationContextTrust (Maybe TlsValidationContextSdsTrust) Source #

A reference to an object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.

tlsValidationContextTrust_file :: Lens' TlsValidationContextTrust (Maybe TlsValidationContextFileTrust) Source #

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

VirtualGatewayAccessLog

virtualGatewayAccessLog_file :: Lens' VirtualGatewayAccessLog (Maybe VirtualGatewayFileAccessLog) Source #

The file object to send virtual gateway access logs to.

VirtualGatewayBackendDefaults

VirtualGatewayClientPolicy

virtualGatewayClientPolicy_tls :: Lens' VirtualGatewayClientPolicy (Maybe VirtualGatewayClientPolicyTls) Source #

A reference to an object that represents a Transport Layer Security (TLS) client policy.

VirtualGatewayClientPolicyTls

virtualGatewayClientPolicyTls_ports :: Lens' VirtualGatewayClientPolicyTls (Maybe [Natural]) Source #

One or more ports that the policy is enforced for.

virtualGatewayClientPolicyTls_certificate :: Lens' VirtualGatewayClientPolicyTls (Maybe VirtualGatewayClientTlsCertificate) Source #

A reference to an object that represents a virtual gateway's client's Transport Layer Security (TLS) certificate.

virtualGatewayClientPolicyTls_enforce :: Lens' VirtualGatewayClientPolicyTls (Maybe Bool) Source #

Whether the policy is enforced. The default is True, if a value isn't specified.

virtualGatewayClientPolicyTls_validation :: Lens' VirtualGatewayClientPolicyTls VirtualGatewayTlsValidationContext Source #

A reference to an object that represents a Transport Layer Security (TLS) validation context.

VirtualGatewayClientTlsCertificate

virtualGatewayClientTlsCertificate_sds :: Lens' VirtualGatewayClientTlsCertificate (Maybe VirtualGatewayListenerTlsSdsCertificate) Source #

A reference to an object that represents a virtual gateway's client's Secret Discovery Service certificate.

virtualGatewayClientTlsCertificate_file :: Lens' VirtualGatewayClientTlsCertificate (Maybe VirtualGatewayListenerTlsFileCertificate) Source #

An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS) .

VirtualGatewayConnectionPool

VirtualGatewayData

virtualGatewayData_meshName :: Lens' VirtualGatewayData Text Source #

The name of the service mesh that the virtual gateway resides in.

virtualGatewayData_spec :: Lens' VirtualGatewayData VirtualGatewaySpec Source #

The specifications of the virtual gateway.

virtualGatewayData_status :: Lens' VirtualGatewayData VirtualGatewayStatus Source #

The current status of the virtual gateway.

VirtualGatewayFileAccessLog

virtualGatewayFileAccessLog_path :: Lens' VirtualGatewayFileAccessLog Text Source #

The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.

VirtualGatewayGrpcConnectionPool

virtualGatewayGrpcConnectionPool_maxRequests :: Lens' VirtualGatewayGrpcConnectionPool Natural Source #

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

VirtualGatewayHealthCheckPolicy

virtualGatewayHealthCheckPolicy_path :: Lens' VirtualGatewayHealthCheckPolicy (Maybe Text) Source #

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

virtualGatewayHealthCheckPolicy_port :: Lens' VirtualGatewayHealthCheckPolicy (Maybe Natural) Source #

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

virtualGatewayHealthCheckPolicy_healthyThreshold :: Lens' VirtualGatewayHealthCheckPolicy Natural Source #

The number of consecutive successful health checks that must occur before declaring the listener healthy.

virtualGatewayHealthCheckPolicy_intervalMillis :: Lens' VirtualGatewayHealthCheckPolicy Natural Source #

The time period in milliseconds between each health check execution.

virtualGatewayHealthCheckPolicy_protocol :: Lens' VirtualGatewayHealthCheckPolicy VirtualGatewayPortProtocol Source #

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

virtualGatewayHealthCheckPolicy_timeoutMillis :: Lens' VirtualGatewayHealthCheckPolicy Natural Source #

The amount of time to wait when receiving a response from the health check, in milliseconds.

virtualGatewayHealthCheckPolicy_unhealthyThreshold :: Lens' VirtualGatewayHealthCheckPolicy Natural Source #

The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.

VirtualGatewayHttp2ConnectionPool

virtualGatewayHttp2ConnectionPool_maxRequests :: Lens' VirtualGatewayHttp2ConnectionPool Natural Source #

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

VirtualGatewayHttpConnectionPool

virtualGatewayHttpConnectionPool_maxPendingRequests :: Lens' VirtualGatewayHttpConnectionPool (Maybe Natural) Source #

Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

virtualGatewayHttpConnectionPool_maxConnections :: Lens' VirtualGatewayHttpConnectionPool Natural Source #

Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

VirtualGatewayListener

virtualGatewayListener_connectionPool :: Lens' VirtualGatewayListener (Maybe VirtualGatewayConnectionPool) Source #

The connection pool information for the virtual gateway listener.

virtualGatewayListener_tls :: Lens' VirtualGatewayListener (Maybe VirtualGatewayListenerTls) Source #

A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

VirtualGatewayListenerTls

virtualGatewayListenerTls_validation :: Lens' VirtualGatewayListenerTls (Maybe VirtualGatewayListenerTlsValidationContext) Source #

A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.

virtualGatewayListenerTls_certificate :: Lens' VirtualGatewayListenerTls VirtualGatewayListenerTlsCertificate Source #

An object that represents a Transport Layer Security (TLS) certificate.

virtualGatewayListenerTls_mode :: Lens' VirtualGatewayListenerTls VirtualGatewayListenerTlsMode Source #

Specify one of the following modes.

  • ____STRICT – Listener only accepts connections with TLS enabled.
  • ____PERMISSIVE – Listener accepts connections with or without TLS enabled.
  • ____DISABLED – Listener only accepts connections without TLS.

VirtualGatewayListenerTlsAcmCertificate

virtualGatewayListenerTlsAcmCertificate_certificateArn :: Lens' VirtualGatewayListenerTlsAcmCertificate Text Source #

The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

VirtualGatewayListenerTlsCertificate

virtualGatewayListenerTlsCertificate_sds :: Lens' VirtualGatewayListenerTlsCertificate (Maybe VirtualGatewayListenerTlsSdsCertificate) Source #

A reference to an object that represents a virtual gateway's listener's Secret Discovery Service certificate.

VirtualGatewayListenerTlsFileCertificate

virtualGatewayListenerTlsFileCertificate_privateKey :: Lens' VirtualGatewayListenerTlsFileCertificate Text Source #

The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.

VirtualGatewayListenerTlsSdsCertificate

virtualGatewayListenerTlsSdsCertificate_secretName :: Lens' VirtualGatewayListenerTlsSdsCertificate Text Source #

A reference to an object that represents the name of the secret secret requested from the Secret Discovery Service provider representing Transport Layer Security (TLS) materials like a certificate or certificate chain.

VirtualGatewayListenerTlsValidationContext

virtualGatewayListenerTlsValidationContext_subjectAlternativeNames :: Lens' VirtualGatewayListenerTlsValidationContext (Maybe SubjectAlternativeNames) Source #

A reference to an object that represents the SANs for a virtual gateway listener's Transport Layer Security (TLS) validation context.

virtualGatewayListenerTlsValidationContext_trust :: Lens' VirtualGatewayListenerTlsValidationContext VirtualGatewayListenerTlsValidationContextTrust Source #

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

VirtualGatewayListenerTlsValidationContextTrust

virtualGatewayListenerTlsValidationContextTrust_sds :: Lens' VirtualGatewayListenerTlsValidationContextTrust (Maybe VirtualGatewayTlsValidationContextSdsTrust) Source #

A reference to an object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualGatewayListenerTlsValidationContextTrust_file :: Lens' VirtualGatewayListenerTlsValidationContextTrust (Maybe VirtualGatewayTlsValidationContextFileTrust) Source #

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

VirtualGatewayLogging

VirtualGatewayPortMapping

virtualGatewayPortMapping_port :: Lens' VirtualGatewayPortMapping Natural Source #

The port used for the port mapping. Specify one protocol.

VirtualGatewayRef

virtualGatewayRef_arn :: Lens' VirtualGatewayRef Text Source #

The full Amazon Resource Name (ARN) for the resource.

virtualGatewayRef_createdAt :: Lens' VirtualGatewayRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

virtualGatewayRef_lastUpdatedAt :: Lens' VirtualGatewayRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

virtualGatewayRef_meshName :: Lens' VirtualGatewayRef Text Source #

The name of the service mesh that the resource resides in.

virtualGatewayRef_meshOwner :: Lens' VirtualGatewayRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

virtualGatewayRef_resourceOwner :: Lens' VirtualGatewayRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

virtualGatewayRef_version :: Lens' VirtualGatewayRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

VirtualGatewaySpec

virtualGatewaySpec_backendDefaults :: Lens' VirtualGatewaySpec (Maybe VirtualGatewayBackendDefaults) Source #

A reference to an object that represents the defaults for backends.

virtualGatewaySpec_listeners :: Lens' VirtualGatewaySpec [VirtualGatewayListener] Source #

The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.

VirtualGatewayStatus

VirtualGatewayTlsValidationContext

virtualGatewayTlsValidationContext_subjectAlternativeNames :: Lens' VirtualGatewayTlsValidationContext (Maybe SubjectAlternativeNames) Source #

A reference to an object that represents the SANs for a virtual gateway's listener's Transport Layer Security (TLS) validation context.

virtualGatewayTlsValidationContext_trust :: Lens' VirtualGatewayTlsValidationContext VirtualGatewayTlsValidationContextTrust Source #

A reference to where to retrieve the trust chain when validating a peer’s Transport Layer Security (TLS) certificate.

VirtualGatewayTlsValidationContextAcmTrust

VirtualGatewayTlsValidationContextFileTrust

virtualGatewayTlsValidationContextFileTrust_certificateChain :: Lens' VirtualGatewayTlsValidationContextFileTrust Text Source #

The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.

VirtualGatewayTlsValidationContextSdsTrust

virtualGatewayTlsValidationContextSdsTrust_secretName :: Lens' VirtualGatewayTlsValidationContextSdsTrust Text Source #

A reference to an object that represents the name of the secret for a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

VirtualGatewayTlsValidationContextTrust

virtualGatewayTlsValidationContextTrust_acm :: Lens' VirtualGatewayTlsValidationContextTrust (Maybe VirtualGatewayTlsValidationContextAcmTrust) Source #

A reference to an object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.

virtualGatewayTlsValidationContextTrust_sds :: Lens' VirtualGatewayTlsValidationContextTrust (Maybe VirtualGatewayTlsValidationContextSdsTrust) Source #

A reference to an object that represents a virtual gateway's Transport Layer Security (TLS) Secret Discovery Service validation context trust.

virtualGatewayTlsValidationContextTrust_file :: Lens' VirtualGatewayTlsValidationContextTrust (Maybe VirtualGatewayTlsValidationContextFileTrust) Source #

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

VirtualNodeConnectionPool

VirtualNodeData

virtualNodeData_meshName :: Lens' VirtualNodeData Text Source #

The name of the service mesh that the virtual node resides in.

virtualNodeData_metadata :: Lens' VirtualNodeData ResourceMetadata Source #

The associated metadata for the virtual node.

virtualNodeData_spec :: Lens' VirtualNodeData VirtualNodeSpec Source #

The specifications of the virtual node.

virtualNodeData_status :: Lens' VirtualNodeData VirtualNodeStatus Source #

The current status for the virtual node.

VirtualNodeGrpcConnectionPool

virtualNodeGrpcConnectionPool_maxRequests :: Lens' VirtualNodeGrpcConnectionPool Natural Source #

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

VirtualNodeHttp2ConnectionPool

virtualNodeHttp2ConnectionPool_maxRequests :: Lens' VirtualNodeHttp2ConnectionPool Natural Source #

Maximum number of inflight requests Envoy can concurrently support across hosts in upstream cluster.

VirtualNodeHttpConnectionPool

virtualNodeHttpConnectionPool_maxPendingRequests :: Lens' VirtualNodeHttpConnectionPool (Maybe Natural) Source #

Number of overflowing requests after max_connections Envoy will queue to upstream cluster.

virtualNodeHttpConnectionPool_maxConnections :: Lens' VirtualNodeHttpConnectionPool Natural Source #

Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

VirtualNodeRef

virtualNodeRef_arn :: Lens' VirtualNodeRef Text Source #

The full Amazon Resource Name (ARN) for the virtual node.

virtualNodeRef_createdAt :: Lens' VirtualNodeRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

virtualNodeRef_lastUpdatedAt :: Lens' VirtualNodeRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

virtualNodeRef_meshName :: Lens' VirtualNodeRef Text Source #

The name of the service mesh that the virtual node resides in.

virtualNodeRef_meshOwner :: Lens' VirtualNodeRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

virtualNodeRef_resourceOwner :: Lens' VirtualNodeRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

virtualNodeRef_version :: Lens' VirtualNodeRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

VirtualNodeServiceProvider

virtualNodeServiceProvider_virtualNodeName :: Lens' VirtualNodeServiceProvider Text Source #

The name of the virtual node that is acting as a service provider.

VirtualNodeSpec

virtualNodeSpec_backends :: Lens' VirtualNodeSpec (Maybe [Backend]) Source #

The backends that the virtual node is expected to send outbound traffic to.

virtualNodeSpec_backendDefaults :: Lens' VirtualNodeSpec (Maybe BackendDefaults) Source #

A reference to an object that represents the defaults for backends.

virtualNodeSpec_serviceDiscovery :: Lens' VirtualNodeSpec (Maybe ServiceDiscovery) Source #

The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter. If you specify a listener, then you must specify service discovery information.

virtualNodeSpec_listeners :: Lens' VirtualNodeSpec (Maybe [Listener]) Source #

The listener that the virtual node is expected to receive inbound traffic from. You can specify one listener.

virtualNodeSpec_logging :: Lens' VirtualNodeSpec (Maybe Logging) Source #

The inbound and outbound access logging information for the virtual node.

VirtualNodeStatus

VirtualNodeTcpConnectionPool

virtualNodeTcpConnectionPool_maxConnections :: Lens' VirtualNodeTcpConnectionPool Natural Source #

Maximum number of outbound TCP connections Envoy can establish concurrently with all hosts in upstream cluster.

VirtualRouterData

virtualRouterData_meshName :: Lens' VirtualRouterData Text Source #

The name of the service mesh that the virtual router resides in.

virtualRouterData_metadata :: Lens' VirtualRouterData ResourceMetadata Source #

The associated metadata for the virtual router.

virtualRouterData_spec :: Lens' VirtualRouterData VirtualRouterSpec Source #

The specifications of the virtual router.

virtualRouterData_status :: Lens' VirtualRouterData VirtualRouterStatus Source #

The current status of the virtual router.

VirtualRouterListener

VirtualRouterRef

virtualRouterRef_arn :: Lens' VirtualRouterRef Text Source #

The full Amazon Resource Name (ARN) for the virtual router.

virtualRouterRef_createdAt :: Lens' VirtualRouterRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

virtualRouterRef_lastUpdatedAt :: Lens' VirtualRouterRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

virtualRouterRef_meshName :: Lens' VirtualRouterRef Text Source #

The name of the service mesh that the virtual router resides in.

virtualRouterRef_meshOwner :: Lens' VirtualRouterRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

virtualRouterRef_resourceOwner :: Lens' VirtualRouterRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

virtualRouterRef_version :: Lens' VirtualRouterRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

VirtualRouterServiceProvider

virtualRouterServiceProvider_virtualRouterName :: Lens' VirtualRouterServiceProvider Text Source #

The name of the virtual router that is acting as a service provider.

VirtualRouterSpec

virtualRouterSpec_listeners :: Lens' VirtualRouterSpec (Maybe (NonEmpty VirtualRouterListener)) Source #

The listeners that the virtual router is expected to receive inbound traffic from. You can specify one listener.

VirtualRouterStatus

VirtualServiceBackend

virtualServiceBackend_clientPolicy :: Lens' VirtualServiceBackend (Maybe ClientPolicy) Source #

A reference to an object that represents the client policy for a backend.

virtualServiceBackend_virtualServiceName :: Lens' VirtualServiceBackend Text Source #

The name of the virtual service that is acting as a virtual node backend.

VirtualServiceData

virtualServiceData_meshName :: Lens' VirtualServiceData Text Source #

The name of the service mesh that the virtual service resides in.

virtualServiceData_spec :: Lens' VirtualServiceData VirtualServiceSpec Source #

The specifications of the virtual service.

virtualServiceData_status :: Lens' VirtualServiceData VirtualServiceStatus Source #

The current status of the virtual service.

VirtualServiceProvider

VirtualServiceRef

virtualServiceRef_arn :: Lens' VirtualServiceRef Text Source #

The full Amazon Resource Name (ARN) for the virtual service.

virtualServiceRef_createdAt :: Lens' VirtualServiceRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was created.

virtualServiceRef_lastUpdatedAt :: Lens' VirtualServiceRef UTCTime Source #

The Unix epoch timestamp in seconds for when the resource was last updated.

virtualServiceRef_meshName :: Lens' VirtualServiceRef Text Source #

The name of the service mesh that the virtual service resides in.

virtualServiceRef_meshOwner :: Lens' VirtualServiceRef Text Source #

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

virtualServiceRef_resourceOwner :: Lens' VirtualServiceRef Text Source #

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

virtualServiceRef_version :: Lens' VirtualServiceRef Integer Source #

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

VirtualServiceSpec

virtualServiceSpec_provider :: Lens' VirtualServiceSpec (Maybe VirtualServiceProvider) Source #

The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.

VirtualServiceStatus

WeightedTarget

weightedTarget_virtualNode :: Lens' WeightedTarget Text Source #

The virtual node to associate with the weighted target.

weightedTarget_weight :: Lens' WeightedTarget Natural Source #

The relative weight of the weighted target.