AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessLog

An object that represents the access logging information for a virtual node.

Class AwsCloudMapInstanceAttribute

An object that represents the AWS Cloud Map attribute information for your virtual node.

Class AwsCloudMapServiceDiscovery

An object that represents the AWS Cloud Map service discovery information for your virtual node.

Class Backend

An object that represents the backends that a virtual node is expected to send outbound traffic to.

Class BackendDefaults

An object that represents the default properties for a backend.

Class BadRequestException

AppMesh exception

Class ClientPolicy

An object that represents a client policy.

Class ClientPolicyTls

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

Class ConflictException

AppMesh exception

Class CreateMeshRequest

Container for the parameters to the CreateMesh operation. Creates a service mesh. A service mesh is a logical boundary for network traffic between the services that reside within it.

After you create your service mesh, you can create virtual services, virtual nodes, virtual routers, and routes to distribute traffic between the applications in your mesh.

Class CreateMeshResponse

This is the response object from the CreateMesh operation.

Class CreateRouteRequest

Container for the parameters to the CreateRoute operation. Creates a route that is associated with a virtual router.

You can use the prefix parameter in your route specification 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.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

For more information about routes, see Routes.

Class CreateRouteResponse

This is the response object from the CreateRoute operation.

Class CreateVirtualNodeRequest

Container for the parameters to the CreateVirtualNode operation. Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value (either the full ARN or the truncated resource name: for example, mesh/default/virtualNode/simpleapp) as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

If you require your Envoy stats or tracing to use a different name, you can override the node.cluster value that is set by APPMESH_VIRTUAL_NODE_NAME with the APPMESH_VIRTUAL_NODE_CLUSTER environment variable.

For more information about virtual nodes, see Virtual Nodes.

Class CreateVirtualNodeResponse

This is the response object from the CreateVirtualNode operation.

Class CreateVirtualRouterRequest

Container for the parameters to the CreateVirtualRouter operation. Creates a virtual router within a service mesh.

Any inbound traffic that your virtual router expects should be specified as a listener.

Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

For more information about virtual routers, see Virtual Routers.

Class CreateVirtualRouterResponse

This is the response object from the CreateVirtualRouter operation.

Class CreateVirtualServiceRequest

Container for the parameters to the CreateVirtualService operation. Creates a virtual service within a service mesh.

A virtual service is an abstraction of a real service that is provided by a virtual node directly or indirectly by means of a virtual router. Dependent services call your virtual service by its virtualServiceName, and those requests are routed to the virtual node or virtual router that is specified as the provider for the virtual service.

For more information about virtual services, see Virtual Services.

Class CreateVirtualServiceResponse

This is the response object from the CreateVirtualService operation.

Class DeleteMeshRequest

Container for the parameters to the DeleteMesh operation. Deletes an existing service mesh.

You must delete all resources (virtual services, routes, virtual routers, and virtual nodes) in the service mesh before you can delete the mesh itself.

Class DeleteMeshResponse

This is the response object from the DeleteMesh operation.

Class DeleteRouteRequest

Container for the parameters to the DeleteRoute operation. Deletes an existing route.

Class DeleteRouteResponse

This is the response object from the DeleteRoute operation.

Class DeleteVirtualNodeRequest

Container for the parameters to the DeleteVirtualNode operation. Deletes an existing virtual node.

You must delete any virtual services that list a virtual node as a service provider before you can delete the virtual node itself.

Class DeleteVirtualNodeResponse

This is the response object from the DeleteVirtualNode operation.

Class DeleteVirtualRouterRequest

Container for the parameters to the DeleteVirtualRouter operation. Deletes an existing virtual router.

You must delete any routes associated with the virtual router before you can delete the router itself.

Class DeleteVirtualRouterResponse

This is the response object from the DeleteVirtualRouter operation.

Class DeleteVirtualServiceRequest

Container for the parameters to the DeleteVirtualService operation. Deletes an existing virtual service.

Class DeleteVirtualServiceResponse

This is the response object from the DeleteVirtualService operation.

Class DescribeMeshRequest

Container for the parameters to the DescribeMesh operation. Describes an existing service mesh.

Class DescribeMeshResponse

This is the response object from the DescribeMesh operation.

Class DescribeRouteRequest

Container for the parameters to the DescribeRoute operation. Describes an existing route.

Class DescribeRouteResponse

This is the response object from the DescribeRoute operation.

Class DescribeVirtualNodeRequest

Container for the parameters to the DescribeVirtualNode operation. Describes an existing virtual node.

Class DescribeVirtualNodeResponse

This is the response object from the DescribeVirtualNode operation.

Class DescribeVirtualRouterRequest

Container for the parameters to the DescribeVirtualRouter operation. Describes an existing virtual router.

Class DescribeVirtualRouterResponse

This is the response object from the DescribeVirtualRouter operation.

Class DescribeVirtualServiceRequest

Container for the parameters to the DescribeVirtualService operation. Describes an existing virtual service.

Class DescribeVirtualServiceResponse

This is the response object from the DescribeVirtualService operation.

Class DnsServiceDiscovery

An object that represents the DNS service discovery information for your virtual node.

Class Duration

An object that represents a duration of time.

Class EgressFilter

An object that represents the egress filter rules for a service mesh.

Class FileAccessLog

An object that represents an access log file.

Class ForbiddenException

AppMesh exception

Class GrpcRetryPolicy

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout.

Class GrpcRoute

An object that represents a gRPC route type.

Class GrpcRouteAction

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

Class GrpcRouteMatch

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

Class GrpcRouteMetadata

An object that represents the match metadata for the route.

Class GrpcRouteMetadataMatchMethod

An object that represents the match method. Specify one of the match values.

Class HeaderMatchMethod

An object that represents the method and value to match with the header value sent in a request. Specify one match method.

Class HealthCheckPolicy

An object that represents the health check policy for a virtual node's listener.

Class HttpRetryPolicy

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout.

Class HttpRoute

An object that represents an HTTP or HTTP/2 route type.

Class HttpRouteAction

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

Class HttpRouteHeader

An object that represents the HTTP header in the request.

Class HttpRouteMatch

An object that represents the requirements for a route to match HTTP requests for a virtual router.

Class InternalServerErrorException

AppMesh exception

Class LimitExceededException

AppMesh exception

Class Listener

An object that represents a listener for a virtual node.

Class ListenerTls

An object that represents the Transport Layer Security (TLS) properties for a listener.

Class ListenerTlsAcmCertificate

An object that represents an AWS Certicate Manager (ACM) certificate.

Class ListenerTlsCertificate

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

Class ListenerTlsFileCertificate

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).

Class ListMeshesRequest

Container for the parameters to the ListMeshes operation. Returns a list of existing service meshes.

Class ListMeshesResponse

This is the response object from the ListMeshes operation.

Class ListRoutesRequest

Container for the parameters to the ListRoutes operation. Returns a list of existing routes in a service mesh.

Class ListRoutesResponse

This is the response object from the ListRoutes operation.

Class ListTagsForResourceRequest

Container for the parameters to the ListTagsForResource operation. List the tags for an App Mesh resource.

Class ListTagsForResourceResponse

This is the response object from the ListTagsForResource operation.

Class ListVirtualNodesRequest

Container for the parameters to the ListVirtualNodes operation. Returns a list of existing virtual nodes.

Class ListVirtualNodesResponse

This is the response object from the ListVirtualNodes operation.

Class ListVirtualRoutersRequest

Container for the parameters to the ListVirtualRouters operation. Returns a list of existing virtual routers in a service mesh.

Class ListVirtualRoutersResponse

This is the response object from the ListVirtualRouters operation.

Class ListVirtualServicesRequest

Container for the parameters to the ListVirtualServices operation. Returns a list of existing virtual services in a service mesh.

Class ListVirtualServicesResponse

This is the response object from the ListVirtualServices operation.

Class Logging

An object that represents the logging information for a virtual node.

Class MatchRange

An object that represents the range of values to match on. The first character of the range is included in the range, though the last character is not. For example, if the range specified were 1-100, only values 1-99 would be matched.

Class MeshData

An object that represents a service mesh returned by a describe operation.

Class MeshRef

An object that represents a service mesh returned by a list operation.

Class MeshSpec

An object that represents the specification of a service mesh.

Class MeshStatus

An object that represents the status of a service mesh.

Class NotFoundException

AppMesh exception

Class PortMapping

An object that represents a port mapping.

Class ResourceInUseException

AppMesh exception

Class ResourceMetadata

An object that represents metadata for a resource.

Class RouteData

An object that represents a route returned by a describe operation.

Class RouteRef

An object that represents a route returned by a list operation.

Class RouteSpec

An object that represents a route specification. Specify one route type.

Class RouteStatus

An object that represents the current status of a route.

Class ServiceDiscovery

An object that represents the service discovery information for a virtual node.

Class ServiceUnavailableException

AppMesh exception

Class TagRef

Optional metadata that you apply to a resource 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.

Class TagResourceRequest

Container for the parameters to the TagResource operation. Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are also deleted.

Class TagResourceResponse

This is the response object from the TagResource operation.

Class TcpRoute

An object that represents a TCP route type.

Class TcpRouteAction

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

Class TlsValidationContext

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

Class TlsValidationContextAcmTrust

An object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.

Class TlsValidationContextFileTrust

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

Class TlsValidationContextTrust

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

Class TooManyRequestsException

AppMesh exception

Class TooManyTagsException

AppMesh exception

Class UntagResourceRequest

Container for the parameters to the UntagResource operation. Deletes specified tags from a resource.

Class UntagResourceResponse

This is the response object from the UntagResource operation.

Class UpdateMeshRequest

Container for the parameters to the UpdateMesh operation. Updates an existing service mesh.

Class UpdateMeshResponse

This is the response object from the UpdateMesh operation.

Class UpdateRouteRequest

Container for the parameters to the UpdateRoute operation. Updates an existing route for a specified service mesh and virtual router.

Class UpdateRouteResponse

This is the response object from the UpdateRoute operation.

Class UpdateVirtualNodeRequest

Container for the parameters to the UpdateVirtualNode operation. Updates an existing virtual node in a specified service mesh.

Class UpdateVirtualNodeResponse

This is the response object from the UpdateVirtualNode operation.

Class UpdateVirtualRouterRequest

Container for the parameters to the UpdateVirtualRouter operation. Updates an existing virtual router in a specified service mesh.

Class UpdateVirtualRouterResponse

This is the response object from the UpdateVirtualRouter operation.

Class UpdateVirtualServiceRequest

Container for the parameters to the UpdateVirtualService operation. Updates an existing virtual service in a specified service mesh.

Class UpdateVirtualServiceResponse

This is the response object from the UpdateVirtualService operation.

Class VirtualNodeData

An object that represents a virtual node returned by a describe operation.

Class VirtualNodeRef

An object that represents a virtual node returned by a list operation.

Class VirtualNodeServiceProvider

An object that represents a virtual node service provider.

Class VirtualNodeSpec

An object that represents the specification of a virtual node.

Class VirtualNodeStatus

An object that represents the current status of the virtual node.

Class VirtualRouterData

An object that represents a virtual router returned by a describe operation.

Class VirtualRouterListener

An object that represents a virtual router listener.

Class VirtualRouterRef

An object that represents a virtual router returned by a list operation.

Class VirtualRouterServiceProvider

An object that represents a virtual node service provider.

Class VirtualRouterSpec

An object that represents the specification of a virtual router.

Class VirtualRouterStatus

An object that represents the status of a virtual router.

Class VirtualServiceBackend

An object that represents a virtual service backend for a virtual node.

Class VirtualServiceData

An object that represents a virtual service returned by a describe operation.

Class VirtualServiceProvider

An object that represents the provider for a virtual service.

Class VirtualServiceRef

An object that represents a virtual service returned by a list operation.

Class VirtualServiceSpec

An object that represents the specification of a virtual service.

Class VirtualServiceStatus

An object that represents the status of a virtual service.

Class WeightedTarget

An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted target with a relative weight of 50 receives five times as much traffic as one with a relative weight of 10. The total weight for all targets combined must be less than or equal to 100.