universal-s3
Version:
Universal S3 SDK for JavaScript, available for Node.js backends
1,222 lines (1,202 loc) • 69 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class AppMesh extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AppMesh.Types.ClientConfiguration)
config: Config & AppMesh.Types.ClientConfiguration;
/**
* 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.
*/
createMesh(params: AppMesh.Types.CreateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
/**
* 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.
*/
createMesh(callback?: (err: AWSError, data: AppMesh.Types.CreateMeshOutput) => void): Request<AppMesh.Types.CreateMeshOutput, AWSError>;
/**
* 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.
*/
createRoute(params: AppMesh.Types.CreateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
/**
* 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.
*/
createRoute(callback?: (err: AWSError, data: AppMesh.Types.CreateRouteOutput) => void): Request<AppMesh.Types.CreateRouteOutput, AWSError>;
/**
* 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.
*/
createVirtualNode(params: AppMesh.Types.CreateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
/**
* 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.
*/
createVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualNodeOutput) => void): Request<AppMesh.Types.CreateVirtualNodeOutput, AWSError>;
/**
* 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.
*/
createVirtualRouter(params: AppMesh.Types.CreateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
/**
* 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.
*/
createVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualRouterOutput) => void): Request<AppMesh.Types.CreateVirtualRouterOutput, AWSError>;
/**
* 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.
*/
createVirtualService(params: AppMesh.Types.CreateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
/**
* 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.
*/
createVirtualService(callback?: (err: AWSError, data: AppMesh.Types.CreateVirtualServiceOutput) => void): Request<AppMesh.Types.CreateVirtualServiceOutput, AWSError>;
/**
* 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.
*/
deleteMesh(params: AppMesh.Types.DeleteMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
/**
* 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.
*/
deleteMesh(callback?: (err: AWSError, data: AppMesh.Types.DeleteMeshOutput) => void): Request<AppMesh.Types.DeleteMeshOutput, AWSError>;
/**
* Deletes an existing route.
*/
deleteRoute(params: AppMesh.Types.DeleteRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
/**
* Deletes an existing route.
*/
deleteRoute(callback?: (err: AWSError, data: AppMesh.Types.DeleteRouteOutput) => void): Request<AppMesh.Types.DeleteRouteOutput, AWSError>;
/**
* 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.
*/
deleteVirtualNode(params: AppMesh.Types.DeleteVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
/**
* 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.
*/
deleteVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualNodeOutput) => void): Request<AppMesh.Types.DeleteVirtualNodeOutput, AWSError>;
/**
* Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the
router itself.
*/
deleteVirtualRouter(params: AppMesh.Types.DeleteVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
/**
* Deletes an existing virtual router.
You must delete any routes associated with the virtual router before you can delete the
router itself.
*/
deleteVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualRouterOutput) => void): Request<AppMesh.Types.DeleteVirtualRouterOutput, AWSError>;
/**
* Deletes an existing virtual service.
*/
deleteVirtualService(params: AppMesh.Types.DeleteVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
/**
* Deletes an existing virtual service.
*/
deleteVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DeleteVirtualServiceOutput) => void): Request<AppMesh.Types.DeleteVirtualServiceOutput, AWSError>;
/**
* Describes an existing service mesh.
*/
describeMesh(params: AppMesh.Types.DescribeMeshInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
/**
* Describes an existing service mesh.
*/
describeMesh(callback?: (err: AWSError, data: AppMesh.Types.DescribeMeshOutput) => void): Request<AppMesh.Types.DescribeMeshOutput, AWSError>;
/**
* Describes an existing route.
*/
describeRoute(params: AppMesh.Types.DescribeRouteInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
/**
* Describes an existing route.
*/
describeRoute(callback?: (err: AWSError, data: AppMesh.Types.DescribeRouteOutput) => void): Request<AppMesh.Types.DescribeRouteOutput, AWSError>;
/**
* Describes an existing virtual node.
*/
describeVirtualNode(params: AppMesh.Types.DescribeVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
/**
* Describes an existing virtual node.
*/
describeVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualNodeOutput) => void): Request<AppMesh.Types.DescribeVirtualNodeOutput, AWSError>;
/**
* Describes an existing virtual router.
*/
describeVirtualRouter(params: AppMesh.Types.DescribeVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
/**
* Describes an existing virtual router.
*/
describeVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualRouterOutput) => void): Request<AppMesh.Types.DescribeVirtualRouterOutput, AWSError>;
/**
* Describes an existing virtual service.
*/
describeVirtualService(params: AppMesh.Types.DescribeVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
/**
* Describes an existing virtual service.
*/
describeVirtualService(callback?: (err: AWSError, data: AppMesh.Types.DescribeVirtualServiceOutput) => void): Request<AppMesh.Types.DescribeVirtualServiceOutput, AWSError>;
/**
* Returns a list of existing service meshes.
*/
listMeshes(params: AppMesh.Types.ListMeshesInput, callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
/**
* Returns a list of existing service meshes.
*/
listMeshes(callback?: (err: AWSError, data: AppMesh.Types.ListMeshesOutput) => void): Request<AppMesh.Types.ListMeshesOutput, AWSError>;
/**
* Returns a list of existing routes in a service mesh.
*/
listRoutes(params: AppMesh.Types.ListRoutesInput, callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
/**
* Returns a list of existing routes in a service mesh.
*/
listRoutes(callback?: (err: AWSError, data: AppMesh.Types.ListRoutesOutput) => void): Request<AppMesh.Types.ListRoutesOutput, AWSError>;
/**
* List the tags for an App Mesh resource.
*/
listTagsForResource(params: AppMesh.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
/**
* List the tags for an App Mesh resource.
*/
listTagsForResource(callback?: (err: AWSError, data: AppMesh.Types.ListTagsForResourceOutput) => void): Request<AppMesh.Types.ListTagsForResourceOutput, AWSError>;
/**
* Returns a list of existing virtual nodes.
*/
listVirtualNodes(params: AppMesh.Types.ListVirtualNodesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
/**
* Returns a list of existing virtual nodes.
*/
listVirtualNodes(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualNodesOutput) => void): Request<AppMesh.Types.ListVirtualNodesOutput, AWSError>;
/**
* Returns a list of existing virtual routers in a service mesh.
*/
listVirtualRouters(params: AppMesh.Types.ListVirtualRoutersInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
/**
* Returns a list of existing virtual routers in a service mesh.
*/
listVirtualRouters(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualRoutersOutput) => void): Request<AppMesh.Types.ListVirtualRoutersOutput, AWSError>;
/**
* Returns a list of existing virtual services in a service mesh.
*/
listVirtualServices(params: AppMesh.Types.ListVirtualServicesInput, callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
/**
* Returns a list of existing virtual services in a service mesh.
*/
listVirtualServices(callback?: (err: AWSError, data: AppMesh.Types.ListVirtualServicesOutput) => void): Request<AppMesh.Types.ListVirtualServicesOutput, AWSError>;
/**
* 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.
*/
tagResource(params: AppMesh.Types.TagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
/**
* 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.
*/
tagResource(callback?: (err: AWSError, data: AppMesh.Types.TagResourceOutput) => void): Request<AppMesh.Types.TagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(params: AppMesh.Types.UntagResourceInput, callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource.
*/
untagResource(callback?: (err: AWSError, data: AppMesh.Types.UntagResourceOutput) => void): Request<AppMesh.Types.UntagResourceOutput, AWSError>;
/**
* Updates an existing service mesh.
*/
updateMesh(params: AppMesh.Types.UpdateMeshInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
/**
* Updates an existing service mesh.
*/
updateMesh(callback?: (err: AWSError, data: AppMesh.Types.UpdateMeshOutput) => void): Request<AppMesh.Types.UpdateMeshOutput, AWSError>;
/**
* Updates an existing route for a specified service mesh and virtual router.
*/
updateRoute(params: AppMesh.Types.UpdateRouteInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
/**
* Updates an existing route for a specified service mesh and virtual router.
*/
updateRoute(callback?: (err: AWSError, data: AppMesh.Types.UpdateRouteOutput) => void): Request<AppMesh.Types.UpdateRouteOutput, AWSError>;
/**
* Updates an existing virtual node in a specified service mesh.
*/
updateVirtualNode(params: AppMesh.Types.UpdateVirtualNodeInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
/**
* Updates an existing virtual node in a specified service mesh.
*/
updateVirtualNode(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualNodeOutput) => void): Request<AppMesh.Types.UpdateVirtualNodeOutput, AWSError>;
/**
* Updates an existing virtual router in a specified service mesh.
*/
updateVirtualRouter(params: AppMesh.Types.UpdateVirtualRouterInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
/**
* Updates an existing virtual router in a specified service mesh.
*/
updateVirtualRouter(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualRouterOutput) => void): Request<AppMesh.Types.UpdateVirtualRouterOutput, AWSError>;
/**
* Updates an existing virtual service in a specified service mesh.
*/
updateVirtualService(params: AppMesh.Types.UpdateVirtualServiceInput, callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
/**
* Updates an existing virtual service in a specified service mesh.
*/
updateVirtualService(callback?: (err: AWSError, data: AppMesh.Types.UpdateVirtualServiceOutput) => void): Request<AppMesh.Types.UpdateVirtualServiceOutput, AWSError>;
}
declare namespace AppMesh {
export interface VirtualRouterListener {
portMapping: PortMapping;
}
export interface UpdateVirtualNodeInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The new virtual node specification to apply. This overwrites the existing data.
*/
spec: VirtualNodeSpec;
/**
* The name of the virtual node to update.
*/
virtualNodeName: ResourceName;
}
export interface DeleteMeshInput {
/**
* The name of the service mesh to delete.
*/
meshName: ResourceName;
}
export type TcpRetryPolicyEvents = TcpRetryPolicyEvent[];
export interface CreateVirtualServiceInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the virtual service in.
*/
meshName: ResourceName;
/**
* The virtual service specification to apply.
*/
spec: VirtualServiceSpec;
/**
* 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.
*/
tags?: TagList;
/**
* The name to use for the virtual service.
*/
virtualServiceName: ServiceName;
}
export type VirtualRouterStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export interface UpdateVirtualRouterInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The new virtual router specification to apply. This overwrites the existing data.
*/
spec: VirtualRouterSpec;
/**
* The name of the virtual router to update.
*/
virtualRouterName: ResourceName;
}
export type TagKeyList = TagKey[];
export interface GrpcRetryPolicy {
/**
* Specify at least one of the valid values.
*/
grpcRetryEvents?: GrpcRetryPolicyEvents;
/**
* 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
*/
httpRetryEvents?: HttpRetryPolicyEvents;
/**
* The maximum number of retry attempts.
*/
maxRetries: MaxRetries;
/**
* An object that represents a duration of time.
*/
perRetryTimeout: Duration;
/**
* Specify a valid value.
*/
tcpRetryEvents?: TcpRetryPolicyEvents;
}
export interface ListTagsForResourceInput {
/**
* 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.
*/
limit?: TagsLimit;
/**
* 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.
*/
nextToken?: String;
/**
* The Amazon Resource Name (ARN) that identifies the resource to list the tags for.
*/
resourceArn: Arn;
}
export interface CreateVirtualNodeOutput {
/**
* The full description of your virtual node following the create call.
*/
virtualNode: VirtualNodeData;
}
export interface Logging {
/**
* The access log configuration for a virtual node.
*/
accessLog?: AccessLog;
}
export type GrpcRetryPolicyEvents = GrpcRetryPolicyEvent[];
export type Long = number;
export interface UpdateVirtualRouterOutput {
/**
* A full description of the virtual router that was updated.
*/
virtualRouter: VirtualRouterData;
}
export interface DescribeMeshOutput {
/**
* The full description of your service mesh.
*/
mesh: MeshData;
}
export interface DeleteVirtualRouterInput {
/**
* The name of the service mesh to delete the virtual router in.
*/
meshName: ResourceName;
/**
* The name of the virtual router to delete.
*/
virtualRouterName: ResourceName;
}
export interface ListVirtualRoutersOutput {
/**
* 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.
*/
nextToken?: String;
/**
* The list of existing virtual routers for the specified service mesh.
*/
virtualRouters: VirtualRouterList;
}
export interface DescribeRouteInput {
/**
* The name of the service mesh that the route resides in.
*/
meshName: ResourceName;
/**
* The name of the route to describe.
*/
routeName: ResourceName;
/**
* The name of the virtual router that the route is associated with.
*/
virtualRouterName: ResourceName;
}
export interface DeleteRouteOutput {
/**
* The route that was deleted.
*/
route: RouteData;
}
export interface ResourceMetadata {
/**
* The full Amazon Resource Name (ARN) for the resource.
*/
arn: Arn;
/**
* The Unix epoch timestamp in seconds for when the resource was created.
*/
createdAt: Timestamp;
/**
* The Unix epoch timestamp in seconds for when the resource was last updated.
*/
lastUpdatedAt: Timestamp;
/**
* The unique identifier for the resource.
*/
uid: String;
/**
* The version of the resource. Resources are created at version 1, and this version is
incremented each time that they're updated.
*/
version: Long;
}
export type Listeners = Listener[];
export type Backends = Backend[];
export type PortProtocol = "grpc"|"http"|"http2"|"tcp"|string;
export interface UpdateVirtualNodeOutput {
/**
* A full description of the virtual node that was updated.
*/
virtualNode: VirtualNodeData;
}
export interface ListRoutesOutput {
/**
* 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.
*/
nextToken?: String;
/**
* The list of existing routes for the specified service mesh and virtual router.
*/
routes: RouteList;
}
export interface VirtualServiceBackend {
/**
* The name of the virtual service that is acting as a virtual node backend.
*/
virtualServiceName: ServiceName;
}
export type VirtualNodeStatusCode = "ACTIVE"|"DELETED"|"INACTIVE"|string;
export type ServiceName = string;
export interface UpdateVirtualServiceInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The new virtual service specification to apply. This overwrites the existing
data.
*/
spec: VirtualServiceSpec;
/**
* The name of the virtual service to update.
*/
virtualServiceName: ServiceName;
}
export type HealthCheckThreshold = number;
export interface UpdateRouteOutput {
/**
* A full description of the route that was updated.
*/
route: RouteData;
}
export type PercentInt = number;
export type GrpcRouteMetadataList = GrpcRouteMetadata[];
export type MethodName = string;
export type TagValue = string;
export interface HttpRouteAction {
/**
* An object that represents the targets that traffic is routed to when a request matches the route.
*/
weightedTargets: WeightedTargets;
}
export interface ListRoutesInput {
/**
* 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.
*/
limit?: ListRoutesLimit;
/**
* The name of the service mesh to list routes in.
*/
meshName: ResourceName;
/**
* 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.
*/
nextToken?: String;
/**
* The name of the virtual router to list routes in.
*/
virtualRouterName: ResourceName;
}
export interface HealthCheckPolicy {
/**
* The number of consecutive successful health checks that must occur before declaring
listener healthy.
*/
healthyThreshold: HealthCheckThreshold;
/**
* The time period in milliseconds between each health check execution.
*/
intervalMillis: HealthCheckIntervalMillis;
/**
* 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.
*/
path?: String;
/**
* The destination port for the health check request. This port must match the port defined
in the PortMapping for the listener.
*/
port?: PortNumber;
/**
* The protocol for the health check request.
*/
protocol: PortProtocol;
/**
* The amount of time to wait when receiving a response from the health check, in
milliseconds.
*/
timeoutMillis: HealthCheckTimeoutMillis;
/**
* The number of consecutive failed health checks that must occur before declaring a
virtual node unhealthy.
*/
unhealthyThreshold: HealthCheckThreshold;
}
export interface VirtualServiceRef {
/**
* The full Amazon Resource Name (ARN) for the virtual service.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual service.
*/
virtualServiceName: ServiceName;
}
export interface EgressFilter {
/**
* 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.
*/
type: EgressFilterType;
}
export type VirtualServiceList = VirtualServiceRef[];
export interface VirtualNodeStatus {
/**
* The current status of the virtual node.
*/
status: VirtualNodeStatusCode;
}
export interface VirtualRouterRef {
/**
* The full Amazon Resource Name (ARN) for the virtual router.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface VirtualServiceData {
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
metadata: ResourceMetadata;
/**
* The specifications of the virtual service.
*/
spec: VirtualServiceSpec;
/**
* The current status of the virtual service.
*/
status: VirtualServiceStatus;
/**
* The name of the virtual service.
*/
virtualServiceName: ServiceName;
}
export type Boolean = boolean;
export interface HttpRouteHeader {
/**
* Specify True to match anything except the match criteria. The default value is False.
*/
invert?: Boolean;
/**
* The HeaderMatchMethod object.
*/
match?: HeaderMatchMethod;
/**
* A name for the HTTP header in the client request that will be matched on.
*/
name: HeaderName;
}
export type HttpRetryPolicyEvent = string;
export interface DescribeVirtualServiceOutput {
/**
* The full description of your virtual service.
*/
virtualService: VirtualServiceData;
}
export type FilePath = string;
export type AwsCloudMapInstanceAttributes = AwsCloudMapInstanceAttribute[];
export interface VirtualNodeRef {
/**
* The full Amazon Resource Name (ARN) for the virtual node.
*/
arn: Arn;
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual node.
*/
virtualNodeName: ResourceName;
}
export interface CreateMeshInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name to use for the service mesh.
*/
meshName: ResourceName;
/**
* The service mesh specification to apply.
*/
spec?: MeshSpec;
/**
* 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.
*/
tags?: TagList;
}
export interface GrpcRouteAction {
/**
* An object that represents the targets that traffic is routed to when a request matches the route.
*/
weightedTargets: WeightedTargets;
}
export interface DescribeVirtualNodeOutput {
/**
* The full description of your virtual node.
*/
virtualNode: VirtualNodeData;
}
export type AwsCloudMapName = string;
export interface UpdateMeshOutput {
mesh: MeshData;
}
export interface CreateRouteOutput {
/**
* The full description of your mesh following the create call.
*/
route: RouteData;
}
export interface GrpcRouteMetadataMatchMethod {
/**
* The value sent by the client must match the specified value exactly.
*/
exact?: HeaderMatch;
/**
* The value sent by the client must begin with the specified characters.
*/
prefix?: HeaderMatch;
/**
* An object that represents the range of values to match on.
*/
range?: MatchRange;
/**
* The value sent by the client must include the specified characters.
*/
regex?: HeaderMatch;
/**
* The value sent by the client must end with the specified characters.
*/
suffix?: HeaderMatch;
}
export interface DnsServiceDiscovery {
/**
* Specifies the DNS service discovery hostname for the virtual node.
*/
hostname: Hostname;
}
export interface DescribeVirtualServiceInput {
/**
* The name of the service mesh that the virtual service resides in.
*/
meshName: ResourceName;
/**
* The name of the virtual service to describe.
*/
virtualServiceName: ServiceName;
}
export type ListVirtualServicesLimit = number;
export interface DeleteRouteInput {
/**
* The name of the service mesh to delete the route in.
*/
meshName: ResourceName;
/**
* The name of the route to delete.
*/
routeName: ResourceName;
/**
* The name of the virtual router to delete the route in.
*/
virtualRouterName: ResourceName;
}
export interface VirtualNodeData {
/**
* The name of the service mesh that the virtual node resides in.
*/
meshName: ResourceName;
/**
* The associated metadata for the virtual node.
*/
metadata: ResourceMetadata;
/**
* The specifications of the virtual node.
*/
spec: VirtualNodeSpec;
/**
* The current status for the virtual node.
*/
status: VirtualNodeStatus;
/**
* The name of the virtual node.
*/
virtualNodeName: ResourceName;
}
export interface UntagResourceOutput {
}
export interface AwsCloudMapInstanceAttribute {
/**
* 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.
*/
key: AwsCloudMapInstanceAttributeKey;
/**
* 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.
*/
value: AwsCloudMapInstanceAttributeValue;
}
export type TcpRetryPolicyEvent = "connection-error"|string;
export interface VirtualServiceSpec {
/**
* The App Mesh object that is acting as the provider for a virtual service. You can specify
a single virtual node or virtual router.
*/
provider?: VirtualServiceProvider;
}
export interface Backend {
/**
* Specifies a virtual service to use as a backend for a virtual node.
*/
virtualService?: VirtualServiceBackend;
}
export interface MatchRange {
/**
* The end of the range.
*/
end: Long;
/**
* The start of the range.
*/
start: Long;
}
export type ListVirtualRoutersLimit = number;
export type HealthCheckIntervalMillis = number;
export type VirtualRouterList = VirtualRouterRef[];
export interface ListMeshesInput {
/**
* 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.
*/
limit?: ListMeshesLimit;
/**
* 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.
*/
nextToken?: String;
}
export type Arn = string;
export interface TcpRoute {
/**
* The action to take if a match is determined.
*/
action: TcpRouteAction;
}
export type VirtualNodeList = VirtualNodeRef[];
export interface ListVirtualRoutersInput {
/**
* 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.
*/
limit?: ListVirtualRoutersLimit;
/**
* The name of the service mesh to list virtual routers in.
*/
meshName: ResourceName;
/**
* 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.
*/
nextToken?: String;
}
export interface VirtualRouterData {
/**
* The name of the service mesh that the virtual router resides in.
*/
meshName: ResourceName;
/**
* The associated metadata for the virtual router.
*/
metadata: ResourceMetadata;
/**
* The specifications of the virtual router.
*/
spec: VirtualRouterSpec;
/**
* The current status of the virtual router.
*/
status: VirtualRouterStatus;
/**
* The name of the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface UpdateMeshInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to update.
*/
meshName: ResourceName;
/**
* The service mesh specification to apply.
*/
spec?: MeshSpec;
}
export type DurationUnit = "ms"|"s"|string;
export type RoutePriority = number;
export interface ListVirtualServicesInput {
/**
* 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.
*/
limit?: ListVirtualServicesLimit;
/**
* The name of the service mesh to list virtual services in.
*/
meshName: ResourceName;
/**
* 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.
*/
nextToken?: String;
}
export interface CreateVirtualRouterInput {
/**
* Unique, case-sensitive identifier that you provide to ensure the idempotency of the
request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
*/
clientToken?: String;
/**
* The name of the service mesh to create the virtual router in.
*/
meshName: ResourceName;
/**
* The virtual router specification to apply.
*/
spec: VirtualRouterSpec;
/**
* 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.
*/
tags?: TagList;
/**
* The name to use for the virtual router.
*/
virtualRouterName: ResourceName;
}
export interface AccessLog {
/**
* The file object to send virtual node access logs to.
*/
file?: FileAccessLog;
}
export interface ListVirtualNodesInput {
/**
* 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.
*/
limit?: ListVirtualNodesLimit;
/**
* The name of the service mesh to list virtual nodes in.
*/
meshName: ResourceName;
/**
* 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.
*/
nextToken?: String;
}
export interface DescribeVirtualRouterOutput {
/**
* The full description of your virtual router.
*/
virtualRouter: VirtualRouterData;
}
export interface CreateMeshOutput {
/**
* The full description of your service mesh following the create call.
*/
mesh: MeshData;
}
export interface CreateVirtualRouterOutput {
/**
* The full description of your virtual router following the create call.
*/
virtualRouter: VirtualRouterData;
}
export interface VirtualServiceStatus {
/**
* The current status of the virtual service.
*/
status: VirtualServiceStatusCode;
}
export type HttpRetryPolicyEvents = HttpRetryPolicyEvent[];
export type ListVirtualNodesLimit = number;
export type HealthCheckTimeoutMillis = number;
export type ListMeshesLimit = number;
export type ResourceName = string;
export type AwsCloudMapInstanceAttributeKey = string;
export interface VirtualRouterSpec {
/**
* The listeners that the virtual router is expected to receive inbound traffic from.
You can specify one listener.
*/
listeners?: VirtualRouterListeners;
}
export type Timestamp = Date;
export type HeaderMatch = string;
export interface VirtualNodeSpec {
/**
* The backends that the virtual node is expected to send outbound traffic to.
*/
backends?: Backends;
/**
* The listeners that the virtual node is expected to receive inbound traffic from.
You can specify one listener.
*/
listeners?: Listeners;
/**
* The inbound and outbound access logging information for the virtual node.
*/
logging?: Logging;
/**
* The service discovery information for the virtual node. If your virtual node does not
expect ingress traffic, you can omit this parameter.
*/
serviceDiscovery?: ServiceDiscovery;
}
export interface ListMeshesOutput {
/**
* The list of existing service meshes.
*/
meshes: MeshList;
/**
* 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.
*/
nextToken?: String;
}
export type VirtualRouterListeners = VirtualRouterListener[];
export type HttpMethod = "CONNECT"|"DELETE"|"GET"|"HEAD"|"OPTIONS"|"PATCH"|"POST"|"PUT"|"TRACE"|string;
export interface Duration {
/**
* A unit of time.
*/
unit?: DurationUnit;
/**
* A number of time units.
*/
value?: DurationValue;
}
export interface DescribeRouteOutput {