The identity and technical contract details declared by the specification.
QueryParameterName
string
VirtualGatewayRef
object
An object that represents a virtual gateway returned by a list operation.
8 properties
8 required
DefaultGatewayRouteRewrite
string
VirtualGatewayListenerTlsValidationContext
object
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
2 properties
1 required
VirtualGatewayListenerTlsFileCertificate
object
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more inf…
2 properties
2 required
GrpcRouteMetadataMatchMethod
object
An object that represents the match method. Specify one of the match values.
5 properties
ListenerTimeout
object
An object that represents timeouts for different protocols.
4 properties
HttpRetryPolicyEvent
string
GatewayRouteData
object
An object that represents a gateway route returned by a describe operation.
6 properties
6 required
OutlierDetection
object
An object that represents the outlier detection for a virtual node's listener.
4 properties
4 required
HttpRetryPolicyEvents
array
JsonFormatRef
object
An object that represents the key value pairs for the JSON.
2 properties
2 required
DeleteVirtualNodeOutput
object
1 property
1 required
HttpGatewayRoutePathRewrite
object
An object that represents the path to rewrite.
1 property
VirtualServiceStatus
object
An object that represents the status of a virtual service.
1 property
1 required
MeshData
object
An object that represents a service mesh returned by a describe operation.
4 properties
4 required
VirtualRouterStatusCode
string
RouteSpec
object
An object that represents a route specification. Specify one route type.
5 properties
VirtualRouterRef
object
An object that represents a virtual router returned by a list operation.
8 properties
8 required
CreateVirtualGatewayOutput
object
1 property
1 required
HttpGatewayRouteRewrite
object
An object representing the gateway route to rewrite.
3 properties
HttpGatewayRouteMatch
object
An object that represents the criteria for determining a request match.
7 properties
VirtualGatewayGrpcConnectionPool
object
An object that represents a type of connection pool.
1 property
1 required
VirtualNodeData
object
An object that represents a virtual node returned by a describe operation.
5 properties
5 required
GatewayRouteVirtualService
object
An object that represents the virtual service that traffic is routed to.
1 property
1 required
MaxPendingRequests
integer
VirtualGatewayTlsValidationContextFileTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
1 property
1 required
AwsCloudMapInstanceAttribute
object
An object that represents the Cloud Map attribute information for your virtual node. Cloud Map is not available in the eu-south-1 Region.
2 properties
2 required
VirtualGatewayClientTlsCertificate
object
An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.
2 properties
HttpRoute
object
An object that represents an HTTP or HTTP/2 route type.
4 properties
2 required
HttpGatewayRouteAction
object
An object that represents the action to take if a match is determined.
2 properties
1 required
TcpTimeout
object
An object that represents types of timeouts.
1 property
VirtualNodeHttp2ConnectionPool
object
An object that represents a type of connection pool.
1 property
1 required
GrpcTimeout
object
An object that represents types of timeouts.
2 properties
DeleteMeshOutput
object
1 property
1 required
VirtualGatewayTlsValidationContext
object
An object that represents a Transport Layer Security (TLS) validation context.
2 properties
1 required
DescribeVirtualRouterOutput
object
1 property
1 required
DeleteVirtualServiceOutput
object
1 property
1 required
PortMapping
object
An object that represents a port mapping.
2 properties
2 required
GrpcRetryPolicy
object
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 pe…
5 properties
2 required
ListVirtualServicesOutput
object
2 properties
1 required
VirtualGatewayListeners
array
SubjectAlternativeNameMatchers
object
An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
1 property
1 required
HttpGatewayRouteHeader
object
An object that represents the HTTP header in the gateway route.
3 properties
1 required
AwsCloudMapInstanceAttributeKey
string
HealthCheckPolicy
object
An object that represents the health check policy for a virtual node's listener.
7 properties
5 required
MeshRef
object
An object that represents a service mesh returned by a list operation.
7 properties
7 required
GrpcRetryPolicyEvents
array
ResourceMetadata
object
An object that represents metadata for a resource.
7 properties
7 required
VirtualRouterSpec
object
An object that represents the specification of a virtual router.
1 property
VirtualNodeServiceProvider
object
An object that represents a virtual node service provider.
1 property
1 required
Listener
object
An object that represents a listener for a virtual node.
6 properties
1 required
DnsServiceDiscovery
object
An object that represents the DNS service discovery information for your virtual node.
3 properties
1 required
RouteData
object
An object that represents a route returned by a describe operation.
6 properties
6 required
VirtualGatewayTlsValidationContextAcmTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
1 property
1 required
VirtualNodeTcpConnectionPool
object
An object that represents a type of connection pool.
1 property
1 required
BackendDefaults
object
An object that represents the default properties for a backend.
1 property
CreateVirtualNodeOutput
object
1 property
1 required
SubjectAlternativeNames
object
An object that represents the subject alternative names secured by the certificate.
1 property
1 required
TcpRetryPolicyEvent
string
GrpcGatewayRoute
object
An object that represents a gRPC gateway route.
2 properties
2 required
VirtualGatewayListenerTlsCertificate
object
An object that represents a listener's Transport Layer Security (TLS) certificate.
3 properties
EgressFilter
object
An object that represents the egress filter rules for a service mesh.
1 property
1 required
DescribeGatewayRouteOutput
object
1 property
1 required
GrpcMetadataMatchMethod
object
An object representing the method header to be matched.
5 properties
VirtualNodeStatusCode
string
VirtualGatewayListenerTlsAcmCertificate
object
An object that represents an Certificate Manager certificate.
1 property
1 required
ListVirtualGatewaysOutput
object
2 properties
1 required
HttpGatewayRoutePrefixRewrite
object
An object representing the beginning characters of the route to rewrite.
2 properties
VirtualNodeSpec
object
An object that represents the specification of a virtual node.
5 properties
VirtualGatewaySdsSecretName
string
VirtualGatewayStatus
object
An object that represents the status of the mesh resource.
1 property
1 required
VirtualGatewayHttp2ConnectionPool
object
An object that represents a type of connection pool.
1 property
1 required
HttpTimeout
object
An object that represents types of timeouts.
2 properties
DescribeMeshOutput
object
1 property
1 required
CreateVirtualRouterOutput
object
1 property
1 required
DescribeVirtualNodeOutput
object
1 property
1 required
VirtualGatewayListenerTlsValidationContextTrust
object
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.
2 properties
VirtualGatewayAccessLog
object
The access log configuration for a virtual gateway.
1 property
VirtualGatewayLogging
object
An object that represents logging information.
1 property
MatchRange
object
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 exa…
2 properties
2 required
WeightedTarget
object
An object that represents a target and its relative weight. Traffic is distributed across targets according to their relative weight. For example, a weighted t…
3 properties
2 required
VirtualGatewayListenerTlsMode
string
HttpRetryPolicy
object
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 pe…
4 properties
2 required
UpdateMeshOutput
object
1 property
1 required
GrpcRouteMetadata
object
An object that represents the match metadata for the route.
3 properties
1 required
UpdateGatewayRouteOutput
object
1 property
1 required
GatewayRouteTarget
object
An object that represents a gateway route target.
2 properties
1 required
GrpcGatewayRouteRewrite
object
An object that represents the gateway route to rewrite.
1 property
ClientPolicy
object
An object that represents a client policy.
1 property
DeleteVirtualGatewayOutput
object
1 property
1 required
HttpGatewayRoutePrefix
string
RouteStatus
object
An object that represents the current status of a route.
1 property
1 required
VirtualGatewayPortProtocol
string
HealthCheckTimeoutMillis
integer
HttpRouteMatch
object
An object that represents the requirements for a route to match HTTP requests for a virtual router.
7 properties
HttpGatewayRouteHeaders
array
VirtualGatewayConnectionPool
object
An object that represents the type of virtual gateway connection pool. Only one protocol is used at a time and should be the same protocol as the one chosen un…
3 properties
VirtualGatewayStatusCode
string
AwsCloudMapInstanceAttributes
array
VirtualNodeStatus
object
An object that represents the current status of the virtual node.
1 property
1 required
DescribeRouteOutput
object
1 property
1 required
VirtualGatewayCertificateAuthorityArns
array
VirtualGatewayClientPolicyTls
object
An object that represents a Transport Layer Security (TLS) client policy.
4 properties
1 required
GatewayRoutePriority
integer
ListenerTls
object
An object that represents the Transport Layer Security (TLS) properties for a listener.
3 properties
2 required
UpdateRouteOutput
object
1 property
1 required
VirtualGatewayHealthCheckTimeoutMillis
integer
ClientTlsCertificate
object
An object that represents the client's certificate.
2 properties
ListVirtualRoutersOutput
object
2 properties
1 required
ServiceUnavailableException
TlsValidationContextAcmTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
1 property
1 required
ClientPolicyTls
object
A reference to an object that represents a Transport Layer Security (TLS) client policy.
4 properties
1 required
VirtualGatewayListener
object
An object that represents a listener for a virtual gateway.
4 properties
1 required
GatewayRouteSpec
object
An object that represents a gateway route specification. Specify one gateway route type.
4 properties
HttpGatewayRoute
object
An object that represents an HTTP gateway route.
2 properties
2 required
VirtualGatewayTlsValidationContextSdsTrust
object
An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be co…
1 property
1 required
FileAccessLog
object
An object that represents an access log file.
2 properties
1 required
GrpcRouteMatch
object
An object that represents the criteria for determining a request match.
4 properties
GrpcRouteAction
object
An object that represents the action to take if a match is determined.
1 property
1 required
TcpRetryPolicyEvents
array
VirtualServiceStatusCode
string
CertificateAuthorityArns
array
UpdateVirtualRouterOutput
object
1 property
1 required
ListenerTlsSdsCertificate
object
An object that represents the listener's Secret Discovery Service certificate. The proxy must be configured with a local SDS provider via a Unix Domain Socket.…
1 property
1 required
HttpRouteAction
object
An object that represents the action to take if a match is determined.
1 property
1 required
TlsValidationContext
object
An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.
2 properties
1 required
VirtualRouterServiceProvider
object
An object that represents a virtual node service provider.
1 property
1 required
VirtualGatewayTlsValidationContextTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust.
3 properties
VirtualServiceBackend
object
An object that represents a virtual service backend for a virtual node.
2 properties
1 required
VirtualGatewayListenerTls
object
An object that represents the Transport Layer Security (TLS) properties for a listener.
3 properties
2 required
CreateMeshOutput
object
1 property
1 required
VirtualServiceData
object
An object that represents a virtual service returned by a describe operation.
5 properties
5 required
LoggingFormat
object
An object that represents the format for the logs.
2 properties
VirtualGatewayListenerTlsSdsCertificate
object
An object that represents the virtual gateway's listener's Secret Discovery Service certificate.The proxy must be configured with a local SDS provider via a Un…
1 property
1 required
DescribeVirtualGatewayOutput
object
1 property
1 required
MeshStatus
object
An object that represents the status of a service mesh.
1 property
TcpRouteMatch
object
An object representing the TCP route to match.
1 property
VirtualGatewayFileAccessLog
object
An object that represents an access log file.
2 properties
1 required
GatewayRouteHostnameMatch
object
An object representing the gateway route host name to match.
2 properties
AccessLog
object
An object that represents the access logging information for a virtual node.
1 property
AwsCloudMapServiceDiscovery
object
An object that represents the Cloud Map service discovery information for your virtual node. Cloud Map is not available in the eu-south-1 Region.
4 properties
2 required
GrpcRouteMetadataList
array
QueryParameterMatch
object
An object representing the query parameter to match.
1 property
VirtualGatewayData
object
An object that represents a virtual gateway returned by a describe operation.
5 properties
5 required
VirtualRouterListener
object
An object that represents a virtual router listener.
1 property
1 required
VirtualNodeGrpcConnectionPool
object
An object that represents a type of connection pool.
1 property
1 required
VirtualNodeHttpConnectionPool
object
An object that represents a type of connection pool.
2 properties
1 required
HttpQueryParameters
array
VirtualRouterData
object
An object that represents a virtual router returned by a describe operation.
5 properties
5 required
Logging
object
An object that represents the logging information for a virtual node.
1 property
VirtualGatewayPortMapping
object
An object that represents a port mapping.
2 properties
2 required
DeleteRouteOutput
object
1 property
1 required
GrpcGatewayRouteMetadata
object
An object representing the metadata of the gateway route.
3 properties
1 required
VirtualRouterStatus
object
An object that represents the status of a virtual router.
1 property
1 required
OutlierDetectionMaxEjectionPercent
integer
ListenerTlsValidationContextTrust
object
An object that represents a listener's Transport Layer Security (TLS) validation context trust.
2 properties
VirtualServiceSpec
object
An object that represents the specification of a virtual service.
1 property
ListGatewayRoutesOutput
object
2 properties
1 required
HttpQueryParameter
object
An object that represents the query parameter in the request.
2 properties
1 required
VirtualGatewayClientPolicy
object
An object that represents a client policy.
1 property
ListenerTlsValidationContext
object
An object that represents a listener's Transport Layer Security (TLS) validation context.
2 properties
1 required
TcpRouteAction
object
An object that represents the action to take if a match is determined.
1 property
1 required
VirtualNodeRef
object
An object that represents a virtual node returned by a list operation.
8 properties
8 required
CreateVirtualServiceOutput
object
1 property
1 required
ListenerTlsCertificate
object
An object that represents a listener's Transport Layer Security (TLS) certificate.
3 properties
TlsValidationContextFileTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
1 property
1 required
RouteRef
object
An object that represents a route returned by a list operation.
9 properties
9 required
GrpcRetryPolicyEvent
string
ListVirtualNodesOutput
object
2 properties
1 required
ListMeshesOutput
object
2 properties
1 required
HealthCheckIntervalMillis
integer
ListenerTlsAcmCertificate
object
An object that represents an Certificate Manager certificate.
1 property
1 required
GatewayRouteStatusCode
string
VirtualServiceProvider
object
An object that represents the provider for a virtual service.
2 properties
Backend
object
An object that represents the backends that a virtual node is expected to send outbound traffic to.
1 property
GatewayRouteRef
object
An object that represents a gateway route returned by a list operation.
9 properties
9 required
SubjectAlternativeNameList
array
VirtualGatewaySpec
object
An object that represents the specification of a service mesh resource.
3 properties
1 required
MeshSpec
object
An object that represents the specification of a service mesh.
2 properties
TlsValidationContextSdsTrust
object
An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS pro…
1 property
1 required
VirtualRouterListeners
array
TcpRoute
object
An object that represents a TCP route type.
3 properties
1 required
HealthCheckThreshold
integer
VirtualGatewayHttpConnectionPool
object
An object that represents a type of connection pool.
2 properties
1 required
UpdateVirtualNodeOutput
object
1 property
1 required
DeleteGatewayRouteOutput
object
1 property
1 required
DeleteVirtualRouterOutput
object
1 property
1 required
GatewayRouteHostnameRewrite
object
An object representing the gateway route host name to rewrite.
1 property
GrpcRoute
object
An object that represents a gRPC route type.
4 properties
2 required
CreateRouteOutput
object
1 property
1 required
SubjectAlternativeName
string
MeshServiceDiscovery
object
An object that represents the service discovery information for a service mesh.
1 property
ListenerTlsFileCertificate
object
An object that represents a local file certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more inf…
2 properties
2 required
Duration
object
An object that represents a duration of time.
2 properties
AwsCloudMapInstanceAttributeValue
string
ServiceDiscovery
object
An object that represents the service discovery information for a virtual node.
2 properties
GatewayRouteStatus
object
An object that represents the current status of a gateway route.
1 property
1 required
OutlierDetectionMaxServerErrors
integer
HeaderMatchMethod
object
An object that represents the method and value to match with the header value sent in a request. Specify one match method.
5 properties
CreateGatewayRouteOutput
object
1 property
1 required
VirtualGatewayHealthCheckThreshold
integer
HttpPathMatch
object
An object representing the path to match in the request.
2 properties
VirtualGatewayBackendDefaults
object
An object that represents the default properties for a backend.
1 property
UpdateVirtualServiceOutput
object
1 property
1 required
HttpRouteHeader
object
An object that represents the HTTP header in the request.
3 properties
1 required
TagRef
object
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…
2 properties
2 required
VirtualServiceRef
object
An object that represents a virtual service returned by a list operation.
8 properties
8 required
ListRoutesOutput
object
2 properties
1 required
InternalServerErrorException
GrpcGatewayRouteAction
object
An object that represents the action to take if a match is determined.
2 properties
1 required
UpdateVirtualGatewayOutput
object
1 property
1 required
DescribeVirtualServiceOutput
object
1 property
1 required
VirtualGatewayHealthCheckPolicy
object
An object that represents the health check policy for a virtual gateway's listener.
7 properties
5 required
GrpcGatewayRouteMatch
object
An object that represents the criteria for determining a request match.
4 properties
TlsValidationContextTrust
object
An object that represents a Transport Layer Security (TLS) validation context trust.
3 properties
VirtualGatewayHealthCheckIntervalMillis
integer
VirtualNodeConnectionPool
object
An object that represents the type of virtual node connection pool. Only one protocol is used at a time and should be the same protocol as the one chosen under…
4 properties
GrpcGatewayRouteMetadataList
array
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Amazon App Mesh publishes across the network.