FileAccessLog file
The file object to send virtual node access logs to.
String key
The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
String value
The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance that contains the specified key and value is returned.
List<E> attributes
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.
String namespaceName
The name of the AWS Cloud Map namespace to use.
String serviceName
The name of the AWS Cloud Map service to use.
VirtualServiceBackend virtualService
Specifies a virtual service to use as a backend for a virtual node.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name to use for the service mesh.
MeshSpec spec
The service mesh specification to apply.
List<E> tags
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.
MeshData mesh
The full description of your service mesh following the create call.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh to create the route in.
String routeName
The name to use for the route.
RouteSpec spec
The route specification to apply.
List<E> tags
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.
String virtualRouterName
The name of the virtual router in which to create the route.
RouteData route
The full description of your mesh following the create call.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh to create the virtual node in.
VirtualNodeSpec spec
The virtual node specification to apply.
List<E> tags
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.
String virtualNodeName
The name to use for the virtual node.
VirtualNodeData virtualNode
The full description of your virtual node following the create call.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh to create the virtual router in.
VirtualRouterSpec spec
The virtual router specification to apply.
List<E> tags
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.
String virtualRouterName
The name to use for the virtual router.
VirtualRouterData virtualRouter
The full description of your virtual router following the create call.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh to create the virtual service in.
VirtualServiceSpec spec
The virtual service specification to apply.
List<E> tags
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.
String virtualServiceName
The name to use for the virtual service.
VirtualServiceData virtualService
The full description of your virtual service following the create call.
String meshName
The name of the service mesh to delete.
MeshData mesh
The service mesh that was deleted.
RouteData route
The route that was deleted.
VirtualNodeData virtualNode
The virtual node that was deleted.
VirtualRouterData virtualRouter
The virtual router that was deleted.
VirtualServiceData virtualService
The virtual service that was deleted.
String meshName
The name of the service mesh to describe.
MeshData mesh
The full description of your service mesh.
RouteData route
The full description of your route.
VirtualNodeData virtualNode
The full description of your virtual node.
VirtualRouterData virtualRouter
The full description of your virtual router.
VirtualServiceData virtualService
The full description of your virtual service.
String hostname
Specifies the DNS service discovery hostname for the virtual node.
String type
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 AWS 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.
String path
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.
List<E> grpcRetryEvents
Specify at least one of the valid values.
List<E> httpRetryEvents
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
Long maxRetries
The maximum number of retry attempts.
Duration perRetryTimeout
An object that represents a duration of time.
List<E> tcpRetryEvents
Specify a valid value.
GrpcRouteAction action
An object that represents the action to take if a match is determined.
GrpcRouteMatch match
An object that represents the criteria for determining a request match.
GrpcRetryPolicy retryPolicy
An object that represents a retry policy.
List<E> metadata
An object that represents the data to match from the request.
String methodName
The method name to match from the request. If you specify a name, you must also specify a
serviceName.
String serviceName
The fully qualified domain name for the service to match from the request.
Boolean invert
Specify True to match anything except the match criteria. The default value is False.
GrpcRouteMetadataMatchMethod match
An object that represents the data to match from the request.
String name
The name of the route.
String exact
The value sent by the client must match the specified value exactly.
String prefix
The value sent by the client must begin with the specified characters.
MatchRange range
An object that represents the range of values to match on.
String regex
The value sent by the client must include the specified characters.
String suffix
The value sent by the client must end with the specified characters.
String exact
The value sent by the client must match the specified value exactly.
String prefix
The value sent by the client must begin with the specified characters.
MatchRange range
An object that represents the range of values to match on.
String regex
The value sent by the client must include the specified characters.
String suffix
The value sent by the client must end with the specified characters.
Integer healthyThreshold
The number of consecutive successful health checks that must occur before declaring listener healthy.
Long intervalMillis
The time period in milliseconds between each health check execution.
String path
The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.
Integer port
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
String protocol
The protocol for the health check request.
Long timeoutMillis
The amount of time to wait when receiving a response from the health check, in milliseconds.
Integer unhealthyThreshold
The number of consecutive failed health checks that must occur before declaring a virtual node unhealthy.
List<E> httpRetryEvents
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
Long maxRetries
The maximum number of retry attempts.
Duration perRetryTimeout
An object that represents a duration of time.
List<E> tcpRetryEvents
Specify a valid value.
HttpRouteAction action
An object that represents the action to take if a match is determined.
HttpRouteMatch match
An object that represents the criteria for determining a request match.
HttpRetryPolicy retryPolicy
An object that represents a retry policy.
Boolean invert
Specify True to match anything except the match criteria. The default value is False.
HeaderMatchMethod match
The HeaderMatchMethod object.
String name
A name for the HTTP header in the client request that will be matched on.
List<E> headers
An object that represents the client request headers to match on.
String method
The client request method to match on. Specify only one.
String prefix
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.
String scheme
The client request scheme to match on. Specify only one.
HealthCheckPolicy healthCheck
The health check information for the listener.
PortMapping portMapping
The port mapping information for the listener.
Integer limit
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.
String nextToken
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.
List<E> meshes
The list of existing service meshes.
String nextToken
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.
Integer limit
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.
String meshName
The name of the service mesh to list routes in.
String nextToken
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.
String virtualRouterName
The name of the virtual router to list routes in.
String nextToken
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.
List<E> routes
The list of existing routes for the specified service mesh and virtual router.
Integer limit
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.
String nextToken
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.
String resourceArn
The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
String nextToken
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.
List<E> tags
The tags for the resource.
Integer limit
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.
String meshName
The name of the service mesh to list virtual nodes in.
String nextToken
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.
String nextToken
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.
List<E> virtualNodes
The list of existing virtual nodes for the specified service mesh.
Integer limit
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.
String meshName
The name of the service mesh to list virtual routers in.
String nextToken
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.
String nextToken
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.
List<E> virtualRouters
The list of existing virtual routers for the specified service mesh.
Integer limit
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.
String meshName
The name of the service mesh to list virtual services in.
String nextToken
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.
String nextToken
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.
List<E> virtualServices
The list of existing virtual services for the specified service mesh.
AccessLog accessLog
The access log configuration for a virtual node.
String meshName
The name of the service mesh.
ResourceMetadata metadata
The associated metadata for the service mesh.
MeshSpec spec
The associated specification for the service mesh.
MeshStatus status
The status of the service mesh.
EgressFilter egressFilter
The egress filter rules for the service mesh.
String status
The current mesh status.
String arn
The full Amazon Resource Name (ARN) for the resource.
Date createdAt
The Unix epoch timestamp in seconds for when the resource was created.
Date lastUpdatedAt
The Unix epoch timestamp in seconds for when the resource was last updated.
String uid
The unique identifier for the resource.
Long version
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
String meshName
The name of the service mesh that the route resides in.
ResourceMetadata metadata
The associated metadata for the route.
String routeName
The name of the route.
RouteSpec spec
The specifications of the route.
RouteStatus status
The status of the route.
String virtualRouterName
The virtual router that the route is associated with.
GrpcRoute grpcRoute
An object that represents the specification of a GRPC route.
HttpRoute http2Route
An object that represents the specification of an HTTP2 route.
HttpRoute httpRoute
An object that represents the specification of an HTTP route.
Integer priority
The priority for the route. Routes are matched based on the specified value, where 0 is the highest priority.
TcpRoute tcpRoute
An object that represents the specification of a TCP route.
String status
The current status for the route.
AwsCloudMapServiceDiscovery awsCloudMap
Specifies any AWS Cloud Map information for the virtual node.
DnsServiceDiscovery dns
Specifies the DNS information for the virtual node.
String resourceArn
The Amazon Resource Name (ARN) of the resource to add tags to.
List<E> tags
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.
TcpRouteAction action
The action to take if a match is determined.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh to update.
MeshSpec spec
The service mesh specification to apply.
MeshData mesh
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh that the route resides in.
String routeName
The name of the route to update.
RouteSpec spec
The new route specification to apply. This overwrites the existing data.
String virtualRouterName
The name of the virtual router that the route is associated with.
RouteData route
A full description of the route that was updated.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh that the virtual node resides in.
VirtualNodeSpec spec
The new virtual node specification to apply. This overwrites the existing data.
String virtualNodeName
The name of the virtual node to update.
VirtualNodeData virtualNode
A full description of the virtual node that was updated.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh that the virtual router resides in.
VirtualRouterSpec spec
The new virtual router specification to apply. This overwrites the existing data.
String virtualRouterName
The name of the virtual router to update.
VirtualRouterData virtualRouter
A full description of the virtual router that was updated.
String clientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
String meshName
The name of the service mesh that the virtual service resides in.
VirtualServiceSpec spec
The new virtual service specification to apply. This overwrites the existing data.
String virtualServiceName
The name of the virtual service to update.
VirtualServiceData virtualService
A full description of the virtual service that was updated.
String meshName
The name of the service mesh that the virtual node resides in.
ResourceMetadata metadata
The associated metadata for the virtual node.
VirtualNodeSpec spec
The specifications of the virtual node.
VirtualNodeStatus status
The current status for the virtual node.
String virtualNodeName
The name of the virtual node.
String virtualNodeName
The name of the virtual node that is acting as a service provider.
List<E> backends
The backends that the virtual node is expected to send outbound traffic to.
List<E> listeners
The listeners that the virtual node is expected to receive inbound traffic from. You can specify one listener.
Logging logging
The inbound and outbound access logging information for the virtual node.
ServiceDiscovery serviceDiscovery
The service discovery information for the virtual node. If your virtual node does not expect ingress traffic, you can omit this parameter.
String status
The current status of the virtual node.
String meshName
The name of the service mesh that the virtual router resides in.
ResourceMetadata metadata
The associated metadata for the virtual router.
VirtualRouterSpec spec
The specifications of the virtual router.
VirtualRouterStatus status
The current status of the virtual router.
String virtualRouterName
The name of the virtual router.
PortMapping portMapping
String virtualRouterName
The name of the virtual router that is acting as a service provider.
String status
The current status of the virtual router.
String virtualServiceName
The name of the virtual service that is acting as a virtual node backend.
String meshName
The name of the service mesh that the virtual service resides in.
ResourceMetadata metadata
VirtualServiceSpec spec
The specifications of the virtual service.
VirtualServiceStatus status
The current status of the virtual service.
String virtualServiceName
The name of the virtual service.
VirtualNodeServiceProvider virtualNode
The virtual node associated with a virtual service.
VirtualRouterServiceProvider virtualRouter
The virtual router associated with a virtual service.
VirtualServiceProvider provider
The App Mesh object that is acting as the provider for a virtual service. You can specify a single virtual node or virtual router.
String status
The current status of the virtual service.
Copyright © 2019. All rights reserved.