Module types

Source

Expand description

Data structures used by operation inputs/outputs.

Modules§

builders: Builders
error: Error types that AWS App Mesh can respond with.

Structs§

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

Cloud Map is not available in the eu-south-1 Region.
AwsCloudMapServiceDiscovery: 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.
BackendDefaults: An object that represents the default properties for a backend.
ClientPolicy: An object that represents a client policy.
ClientPolicyTls: A reference to an object that represents a Transport Layer Security (TLS) client policy.
DnsServiceDiscovery: An object that represents the DNS service discovery information for your virtual node.
Duration: An object that represents a duration of time.
EgressFilter: An object that represents the egress filter rules for a service mesh.
FileAccessLog: An object that represents an access log file.
GatewayRouteData: An object that represents a gateway route returned by a describe operation.
GatewayRouteHostnameMatch: An object representing the gateway route host name to match.
GatewayRouteHostnameRewrite: An object representing the gateway route host name to rewrite.
GatewayRouteRef: An object that represents a gateway route returned by a list operation.
GatewayRouteSpec: An object that represents a gateway route specification. Specify one gateway route type.
GatewayRouteStatus: An object that represents the current status of a gateway route.
GatewayRouteTarget: An object that represents a gateway route target.
GatewayRouteVirtualService: An object that represents the virtual service that traffic is routed to.
GrpcGatewayRoute: An object that represents a gRPC gateway route.
GrpcGatewayRouteAction: An object that represents the action to take if a match is determined.
GrpcGatewayRouteMatch: An object that represents the criteria for determining a request match.
GrpcGatewayRouteMetadata: An object representing the metadata of the gateway route.
GrpcGatewayRouteRewrite: An object that represents the gateway route to rewrite.
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. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation.
GrpcRoute: An object that represents a gRPC route type.
GrpcRouteAction: An object that represents the action to take if a match is determined.
GrpcRouteMatch: An object that represents the criteria for determining a request match.
GrpcRouteMetadata: An object that represents the match metadata for the route.
GrpcTimeout: An object that represents types of timeouts.
HealthCheckPolicy: An object that represents the health check policy for a virtual node's listener.
HttpGatewayRoute: An object that represents an HTTP gateway route.
HttpGatewayRouteAction: An object that represents the action to take if a match is determined.
HttpGatewayRouteHeader: An object that represents the HTTP header in the gateway route.
HttpGatewayRouteMatch: An object that represents the criteria for determining a request match.
HttpGatewayRoutePathRewrite: An object that represents the path to rewrite.
HttpGatewayRoutePrefixRewrite: An object representing the beginning characters of the route to rewrite.
HttpGatewayRouteRewrite: An object representing the gateway route to rewrite.
HttpPathMatch: An object representing the path to match in the request.
HttpQueryParameter: An object that represents the query parameter in the request.
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. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation.
HttpRoute: An object that represents an HTTP or HTTP/2 route type.
HttpRouteAction: An object that represents the action to take if a match is determined.
HttpRouteHeader: An object that represents the HTTP header in the request.
HttpRouteMatch: An object that represents the requirements for a route to match HTTP requests for a virtual router.
HttpTimeout: An object that represents types of timeouts.
JsonFormatRef: An object that represents the key value pairs for the JSON.
Listener: An object that represents a listener for a virtual node.
ListenerTls: An object that represents the Transport Layer Security (TLS) properties for a listener.
ListenerTlsAcmCertificate: An object that represents an Certificate Manager certificate.
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).
ListenerTlsSdsCertificate: 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. See App Mesh TLS documentation for more info.
ListenerTlsValidationContext: An object that represents a listener's Transport Layer Security (TLS) validation context.
Logging: An object that represents the logging information for a virtual node.
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.
MeshData: An object that represents a service mesh returned by a describe operation.
MeshRef: An object that represents a service mesh returned by a list operation.
MeshServiceDiscovery: An object that represents the service discovery information for a service mesh.
MeshSpec: An object that represents the specification of a service mesh.
MeshStatus: An object that represents the status of a service mesh.
OutlierDetection: An object that represents the outlier detection for a virtual node's listener.
PortMapping: An object that represents a port mapping.
QueryParameterMatch: An object representing the query parameter to match.
ResourceMetadata: An object that represents metadata for a resource.
RouteData: An object that represents a route returned by a describe operation.
RouteRef: An object that represents a route returned by a list operation.
RouteSpec: An object that represents a route specification. Specify one route type.
RouteStatus: An object that represents the current status of a route.
SubjectAlternativeNameMatchers: An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
SubjectAlternativeNames: An object that represents the subject alternative names secured by the certificate.
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.
TcpRoute: An object that represents a TCP route type.
TcpRouteAction: An object that represents the action to take if a match is determined.
TcpRouteMatch: An object representing the TCP route to match.
TcpTimeout: An object that represents types of timeouts.
TlsValidationContext: An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.
TlsValidationContextAcmTrust: An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
TlsValidationContextFileTrust: An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
TlsValidationContextSdsTrust: An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
VirtualGatewayBackendDefaults: An object that represents the default properties for a backend.
VirtualGatewayClientPolicy: An object that represents a client policy.
VirtualGatewayClientPolicyTls: An object that represents a Transport Layer Security (TLS) client policy.
VirtualGatewayData: An object that represents a virtual gateway returned by a describe operation.
VirtualGatewayFileAccessLog: An object that represents an access log file.
VirtualGatewayGrpcConnectionPool: An object that represents a type of connection pool.
VirtualGatewayHealthCheckPolicy: An object that represents the health check policy for a virtual gateway's listener.
VirtualGatewayHttp2ConnectionPool: An object that represents a type of connection pool.
VirtualGatewayHttpConnectionPool: An object that represents a type of connection pool.
VirtualGatewayListener: An object that represents a listener for a virtual gateway.
VirtualGatewayListenerTls: An object that represents the Transport Layer Security (TLS) properties for a listener.
VirtualGatewayListenerTlsAcmCertificate: An object that represents an Certificate Manager certificate.
VirtualGatewayListenerTlsFileCertificate: 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).
VirtualGatewayListenerTlsSdsCertificate: 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 Unix Domain Socket. See App MeshTLS documentation for more info.
VirtualGatewayListenerTlsValidationContext: An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
VirtualGatewayLogging: An object that represents logging information.
VirtualGatewayPortMapping: An object that represents a port mapping.
VirtualGatewayRef: An object that represents a virtual gateway returned by a list operation.
VirtualGatewaySpec: An object that represents the specification of a service mesh resource.
VirtualGatewayStatus: An object that represents the status of the mesh resource.
VirtualGatewayTlsValidationContext: An object that represents a Transport Layer Security (TLS) validation context.
VirtualGatewayTlsValidationContextAcmTrust: An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
VirtualGatewayTlsValidationContextFileTrust: An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
VirtualGatewayTlsValidationContextSdsTrust: An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust. The proxy must be configured with a local SDS provider via a Unix Domain Socket. See App Mesh TLS documentation for more info.
VirtualNodeData: An object that represents a virtual node returned by a describe operation.
VirtualNodeGrpcConnectionPool: An object that represents a type of connection pool.
VirtualNodeHttp2ConnectionPool: An object that represents a type of connection pool.
VirtualNodeHttpConnectionPool: An object that represents a type of connection pool.
VirtualNodeRef: An object that represents a virtual node returned by a list operation.
VirtualNodeServiceProvider: An object that represents a virtual node service provider.
VirtualNodeSpec: An object that represents the specification of a virtual node.
VirtualNodeStatus: An object that represents the current status of the virtual node.
VirtualNodeTcpConnectionPool: An object that represents a type of connection pool.
VirtualRouterData: An object that represents a virtual router returned by a describe operation.
VirtualRouterListener: An object that represents a virtual router listener.
VirtualRouterRef: An object that represents a virtual router returned by a list operation.
VirtualRouterServiceProvider: An object that represents a virtual node service provider.
VirtualRouterSpec: An object that represents the specification of a virtual router.
VirtualRouterStatus: An object that represents the status of a virtual router.
VirtualServiceBackend: An object that represents a virtual service backend for a virtual node.
VirtualServiceData: An object that represents a virtual service returned by a describe operation.
VirtualServiceRef: An object that represents a virtual service returned by a list operation.
VirtualServiceSpec: An object that represents the specification of a virtual service.
VirtualServiceStatus: An object that represents the status of a virtual service.
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.

Enums§

AccessLog

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

Backend

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

ClientTlsCertificate

An object that represents the client's certificate.

DefaultGatewayRouteRewrite

When writing a match expression against DefaultGatewayRouteRewrite, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DnsResponseType

When writing a match expression against DnsResponseType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DurationUnit

When writing a match expression against DurationUnit, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EgressFilterType

When writing a match expression against EgressFilterType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GatewayRouteStatusCode

When writing a match expression against GatewayRouteStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GrpcMetadataMatchMethod

An object representing the method header to be matched.

GrpcRetryPolicyEvent

When writing a match expression against GrpcRetryPolicyEvent, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

GrpcRouteMetadataMatchMethod

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

HeaderMatchMethod

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

HttpMethod

When writing a match expression against HttpMethod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

HttpScheme

When writing a match expression against HttpScheme, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IpPreference

When writing a match expression against IpPreference, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ListenerTimeout

An object that represents timeouts for different protocols.

ListenerTlsCertificate

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

ListenerTlsMode

When writing a match expression against ListenerTlsMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ListenerTlsValidationContextTrust

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

LoggingFormat

An object that represents the format for the logs.

MeshStatusCode

When writing a match expression against MeshStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PortProtocol

When writing a match expression against PortProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

RouteStatusCode

When writing a match expression against RouteStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ServiceDiscovery

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

TcpRetryPolicyEvent

When writing a match expression against TcpRetryPolicyEvent, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

TlsValidationContextTrust

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

VirtualGatewayAccessLog

The access log configuration for a virtual gateway.

VirtualGatewayClientTlsCertificate

An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.

VirtualGatewayConnectionPool

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 under port mapping.

If not present the default value for maxPendingRequests is 2147483647.

VirtualGatewayListenerTlsCertificate

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

VirtualGatewayListenerTlsMode

When writing a match expression against VirtualGatewayListenerTlsMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VirtualGatewayListenerTlsValidationContextTrust

An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.

VirtualGatewayPortProtocol

When writing a match expression against VirtualGatewayPortProtocol, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VirtualGatewayStatusCode

When writing a match expression against VirtualGatewayStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VirtualGatewayTlsValidationContextTrust

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

VirtualNodeConnectionPool

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 port mapping.

If not present the default value for maxPendingRequests is 2147483647.

VirtualNodeStatusCode

When writing a match expression against VirtualNodeStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VirtualRouterStatusCode

When writing a match expression against VirtualRouterStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

VirtualServiceProvider

An object that represents the provider for a virtual service.

VirtualServiceStatusCode

When writing a match expression against VirtualServiceStatusCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Module typesCopy item path

Modules§

Structs§

Enums§

Module types