Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@datafire/amazonaws_appmesh

DataFire2MIT5.0.0

DataFire integration for AWS App Mesh

readme

@datafire/amazonaws_appmesh

Client library for AWS App Mesh

Installation and Usage

npm install --save @datafire/amazonaws_appmesh
let amazonaws_appmesh = require('@datafire/amazonaws_appmesh').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and control microservices. App Mesh standardizes how your microservices communicate, giving you end-to-end visibility and helping to ensure high availability for your applications.

App Mesh gives you consistent visibility and network traffic controls for every microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS, Kubernetes on AWS, and Amazon EC2.

<note>

App Mesh supports microservice applications that use service discovery naming for their components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes kube-dns and coredns are supported. For more information, see DNS for Services and Pods in the Kubernetes documentation.

</note>

Actions

ListMeshes

amazonaws_appmesh.ListMeshes({}, context)

Input

  • input object
    • limit integer
    • nextToken string

Output

CreateMesh

amazonaws_appmesh.CreateMesh({
  "meshName": ""
}, context)

Input

  • input object
    • tags array: 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • meshName required string: The name to use for the service mesh.
    • spec object: An object that represents the specification of a service mesh.
      • egressFilter
        • type required

Output

DeleteMesh

amazonaws_appmesh.DeleteMesh({
  "meshName": ""
}, context)

Input

  • input object
    • meshName required string

Output

DescribeMesh

amazonaws_appmesh.DescribeMesh({
  "meshName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string

Output

UpdateMesh

amazonaws_appmesh.UpdateMesh({
  "meshName": ""
}, context)

Input

  • input object
    • meshName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec object: An object that represents the specification of a service mesh.
      • egressFilter
        • type required

Output

ListGatewayRoutes

amazonaws_appmesh.ListGatewayRoutes({
  "meshName": "",
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string
    • virtualGatewayName required string

Output

CreateGatewayRoute

amazonaws_appmesh.CreateGatewayRoute({
  "meshName": "",
  "virtualGatewayName": "",
  "gatewayRouteName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string
    • tags array: Optional metadata that you can apply to the gateway 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • gatewayRouteName required string: The name to use for the gateway route.
    • spec required object: An object that represents a gateway route specification. Specify one gateway route type.
      • grpcRoute
        • action required
          • target required
            • virtualService required
        • match required
          • serviceName
      • http2Route
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required
      • httpRoute
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required

Output

DeleteGatewayRoute

amazonaws_appmesh.DeleteGatewayRoute({
  "gatewayRouteName": "",
  "meshName": "",
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • gatewayRouteName required string
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string

Output

DescribeGatewayRoute

amazonaws_appmesh.DescribeGatewayRoute({
  "gatewayRouteName": "",
  "meshName": "",
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • gatewayRouteName required string
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string

Output

UpdateGatewayRoute

amazonaws_appmesh.UpdateGatewayRoute({
  "gatewayRouteName": "",
  "meshName": "",
  "virtualGatewayName": "",
  "spec": {}
}, context)

Input

  • input object
    • gatewayRouteName required string
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents a gateway route specification. Specify one gateway route type.
      • grpcRoute
        • action required
          • target required
            • virtualService required
        • match required
          • serviceName
      • http2Route
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required
      • httpRoute
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required

Output

ListVirtualGateways

amazonaws_appmesh.ListVirtualGateways({
  "meshName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string

Output

CreateVirtualGateway

amazonaws_appmesh.CreateVirtualGateway({
  "meshName": "",
  "spec": {},
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • tags array: Optional metadata that you can apply to the virtual gateway 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a service mesh resource.
    • virtualGatewayName required string: The name to use for the virtual gateway.

Output

DeleteVirtualGateway

amazonaws_appmesh.DeleteVirtualGateway({
  "meshName": "",
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string

Output

DescribeVirtualGateway

amazonaws_appmesh.DescribeVirtualGateway({
  "meshName": "",
  "virtualGatewayName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string

Output

UpdateVirtualGateway

amazonaws_appmesh.UpdateVirtualGateway({
  "meshName": "",
  "virtualGatewayName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualGatewayName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a service mesh resource.

Output

ListVirtualNodes

amazonaws_appmesh.ListVirtualNodes({
  "meshName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string

Output

CreateVirtualNode

amazonaws_appmesh.CreateVirtualNode({
  "meshName": "",
  "spec": {},
  "virtualNodeName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • tags array: 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual node.
      • backendDefaults
        • clientPolicy
          • tls
            • enforce
            • ports
            • validation required
      • backends
      • listeners
      • logging
        • accessLog
          • file
            • path required
      • serviceDiscovery
    • virtualNodeName required string: The name to use for the virtual node.

Output

DeleteVirtualNode

amazonaws_appmesh.DeleteVirtualNode({
  "meshName": "",
  "virtualNodeName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualNodeName required string

Output

DescribeVirtualNode

amazonaws_appmesh.DescribeVirtualNode({
  "meshName": "",
  "virtualNodeName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualNodeName required string

Output

UpdateVirtualNode

amazonaws_appmesh.UpdateVirtualNode({
  "meshName": "",
  "virtualNodeName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualNodeName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual node.
      • backendDefaults
        • clientPolicy
          • tls
            • enforce
            • ports
            • validation required
      • backends
      • listeners
      • logging
        • accessLog
          • file
            • path required
      • serviceDiscovery

Output

ListRoutes

amazonaws_appmesh.ListRoutes({
  "meshName": "",
  "virtualRouterName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string
    • virtualRouterName required string

Output

CreateRoute

amazonaws_appmesh.CreateRoute({
  "meshName": "",
  "virtualRouterName": "",
  "routeName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualRouterName required string
    • tags array: 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • routeName required string: The name to use for the route.
    • spec required object: An object that represents a route specification. Specify one route type.

Output

DeleteRoute

amazonaws_appmesh.DeleteRoute({
  "meshName": "",
  "routeName": "",
  "virtualRouterName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • routeName required string
    • virtualRouterName required string

Output

DescribeRoute

amazonaws_appmesh.DescribeRoute({
  "meshName": "",
  "routeName": "",
  "virtualRouterName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • routeName required string
    • virtualRouterName required string

Output

UpdateRoute

amazonaws_appmesh.UpdateRoute({
  "meshName": "",
  "routeName": "",
  "virtualRouterName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • routeName required string
    • virtualRouterName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents a route specification. Specify one route type.

Output

ListVirtualRouters

amazonaws_appmesh.ListVirtualRouters({
  "meshName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string

Output

CreateVirtualRouter

amazonaws_appmesh.CreateVirtualRouter({
  "meshName": "",
  "spec": {},
  "virtualRouterName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • tags array: 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual router.
    • virtualRouterName required string: The name to use for the virtual router.

Output

DeleteVirtualRouter

amazonaws_appmesh.DeleteVirtualRouter({
  "meshName": "",
  "virtualRouterName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualRouterName required string

Output

DescribeVirtualRouter

amazonaws_appmesh.DescribeVirtualRouter({
  "meshName": "",
  "virtualRouterName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualRouterName required string

Output

UpdateVirtualRouter

amazonaws_appmesh.UpdateVirtualRouter({
  "meshName": "",
  "virtualRouterName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualRouterName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual router.

Output

ListVirtualServices

amazonaws_appmesh.ListVirtualServices({
  "meshName": ""
}, context)

Input

  • input object
    • limit integer
    • meshName required string
    • meshOwner string
    • nextToken string

Output

CreateVirtualService

amazonaws_appmesh.CreateVirtualService({
  "meshName": "",
  "spec": {},
  "virtualServiceName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • tags array: 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.
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual service.
      • provider
        • virtualNode
          • virtualNodeName required
        • virtualRouter
          • virtualRouterName required
    • virtualServiceName required string: The name to use for the virtual service.

Output

DeleteVirtualService

amazonaws_appmesh.DeleteVirtualService({
  "meshName": "",
  "virtualServiceName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualServiceName required string

Output

DescribeVirtualService

amazonaws_appmesh.DescribeVirtualService({
  "meshName": "",
  "virtualServiceName": ""
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualServiceName required string

Output

UpdateVirtualService

amazonaws_appmesh.UpdateVirtualService({
  "meshName": "",
  "virtualServiceName": "",
  "spec": {}
}, context)

Input

  • input object
    • meshName required string
    • meshOwner string
    • virtualServiceName required string
    • clientToken string: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.
    • spec required object: An object that represents the specification of a virtual service.
      • provider
        • virtualNode
          • virtualNodeName required
        • virtualRouter
          • virtualRouterName required

Output

TagResource

amazonaws_appmesh.TagResource({
  "resourceArn": "",
  "tags": []
}, context)

Input

  • input object
    • resourceArn required string
    • tags required array: 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.

Output

ListTagsForResource

amazonaws_appmesh.ListTagsForResource({
  "resourceArn": ""
}, context)

Input

  • input object
    • limit integer
    • nextToken string
    • resourceArn required string

Output

UntagResource

amazonaws_appmesh.UntagResource({
  "resourceArn": "",
  "tagKeys": []
}, context)

Input

  • input object
    • resourceArn required string
    • tagKeys required array: The keys of the tags to be removed.

Output

Definitions

AccessLog

  • AccessLog object: An object that represents the access logging information for a virtual node.
    • file
      • path required

AccountId

  • AccountId string

Arn

  • Arn string

AwsCloudMapInstanceAttribute

  • AwsCloudMapInstanceAttribute object:

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

    <note>

    AWS Cloud Map is not available in the eu-south-1 Region.

    </note>
    • key required
    • value required

AwsCloudMapInstanceAttributeKey

  • AwsCloudMapInstanceAttributeKey string

AwsCloudMapInstanceAttributeValue

  • AwsCloudMapInstanceAttributeValue string

AwsCloudMapInstanceAttributes

AwsCloudMapName

  • AwsCloudMapName string

AwsCloudMapServiceDiscovery

  • AwsCloudMapServiceDiscovery object:

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

    <note>

    AWS Cloud Map is not available in the eu-south-1 Region.

    </note>

Backend

  • Backend object: An object that represents the backends that a virtual node is expected to send outbound traffic to.
    • virtualService
      • clientPolicy
        • tls
          • enforce
          • ports
          • validation required
            • trust required
      • virtualServiceName required

BackendDefaults

  • BackendDefaults object: An object that represents the default properties for a backend.
    • clientPolicy
      • tls
        • enforce
        • ports
        • validation required
          • trust required
            • acm
            • file

Backends

BadRequestException

Boolean

  • Boolean boolean

CertificateAuthorityArns

  • CertificateAuthorityArns array

ClientPolicy

  • ClientPolicy object: An object that represents a client policy.
    • tls
      • enforce
      • ports
      • validation required
        • trust required
          • acm
            • certificateAuthorityArns required
          • file
            • certificateChain required

ClientPolicyTls

  • ClientPolicyTls object: A reference to an object that represents a Transport Layer Security (TLS) client policy.
    • enforce
    • ports
    • validation required
      • trust required
        • acm
          • certificateAuthorityArns required
        • file
          • certificateChain required

ConflictException

CreateGatewayRouteInput

  • CreateGatewayRouteInput object
    • tags
    • clientToken
    • gatewayRouteName required
    • spec required
      • grpcRoute
        • action required
          • target required
            • virtualService required
        • match required
          • serviceName
      • http2Route
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required
      • httpRoute
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required

CreateGatewayRouteOutput

  • CreateGatewayRouteOutput object
    • gatewayRoute required
      • gatewayRouteName required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • grpcRoute
          • action required
            • target required
          • match required
            • serviceName
        • http2Route
          • action required
            • target required
          • match required
            • prefix required
        • httpRoute
          • action required
            • target required
          • match required
            • prefix required
      • status required
        • status required
      • virtualGatewayName required

CreateMeshInput

  • CreateMeshInput object: <zonbook></zonbook><xhtml></xhtml>
    • tags
    • clientToken
    • meshName required
    • spec
      • egressFilter
        • type required

CreateMeshOutput

  • CreateMeshOutput object: <zonbook></zonbook><xhtml></xhtml>
    • mesh required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • egressFilter
          • type required
      • status required
        • status

CreateRouteInput

  • CreateRouteInput object: <zonbook></zonbook><xhtml></xhtml>
    • tags
    • clientToken
    • routeName required
    • spec required

CreateRouteOutput

  • CreateRouteOutput object: <zonbook></zonbook><xhtml></xhtml>
    • route required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • routeName required
      • spec required
        • grpcRoute
          • action required
            • weightedTargets required
          • match required
            • metadata
            • methodName
            • serviceName
          • retryPolicy
            • grpcRetryEvents
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • http2Route
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • httpRoute
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • priority
        • tcpRoute
          • action required
            • weightedTargets required
          • timeout
            • idle
      • status required
        • status required
      • virtualRouterName required

CreateVirtualGatewayInput

  • CreateVirtualGatewayInput object

CreateVirtualGatewayOutput

  • CreateVirtualGatewayOutput object

CreateVirtualNodeInput

  • CreateVirtualNodeInput object: <zonbook></zonbook><xhtml></xhtml>
    • tags
    • clientToken
    • spec required
      • backendDefaults
        • clientPolicy
          • tls
            • enforce
            • ports
            • validation required
      • backends
      • listeners
      • logging
        • accessLog
          • file
            • path required
      • serviceDiscovery
    • virtualNodeName required

CreateVirtualNodeOutput

  • CreateVirtualNodeOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualNode required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • backendDefaults
          • clientPolicy
            • tls
        • backends
        • listeners
        • logging
          • accessLog
            • file
        • serviceDiscovery
          • awsCloudMap
            • attributes
            • namespaceName required
            • serviceName required
          • dns
            • hostname required
      • status required
        • status required
      • virtualNodeName required

CreateVirtualRouterInput

  • CreateVirtualRouterInput object: <zonbook></zonbook><xhtml></xhtml>

CreateVirtualRouterOutput

  • CreateVirtualRouterOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualRouter required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
      • status required
        • status required
      • virtualRouterName required

CreateVirtualServiceInput

  • CreateVirtualServiceInput object: <zonbook></zonbook><xhtml></xhtml>
    • tags
    • clientToken
    • spec required
      • provider
        • virtualNode
          • virtualNodeName required
        • virtualRouter
          • virtualRouterName required
    • virtualServiceName required

CreateVirtualServiceOutput

  • CreateVirtualServiceOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualService required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • provider
          • virtualNode
            • virtualNodeName required
          • virtualRouter
            • virtualRouterName required
      • status required
        • status required
      • virtualServiceName required

DeleteGatewayRouteInput

  • DeleteGatewayRouteInput object

DeleteGatewayRouteOutput

  • DeleteGatewayRouteOutput object
    • gatewayRoute required
      • gatewayRouteName required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • grpcRoute
          • action required
            • target required
          • match required
            • serviceName
        • http2Route
          • action required
            • target required
          • match required
            • prefix required
        • httpRoute
          • action required
            • target required
          • match required
            • prefix required
      • status required
        • status required
      • virtualGatewayName required

DeleteMeshInput

  • DeleteMeshInput object: <zonbook></zonbook><xhtml></xhtml>

DeleteMeshOutput

  • DeleteMeshOutput object: <zonbook></zonbook><xhtml></xhtml>
    • mesh required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • egressFilter
          • type required
      • status required
        • status

DeleteRouteInput

  • DeleteRouteInput object: <zonbook></zonbook><xhtml></xhtml>

DeleteRouteOutput

  • DeleteRouteOutput object: <zonbook></zonbook><xhtml></xhtml>
    • route required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • routeName required
      • spec required
        • grpcRoute
          • action required
            • weightedTargets required
          • match required
            • metadata
            • methodName
            • serviceName
          • retryPolicy
            • grpcRetryEvents
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • http2Route
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • httpRoute
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • priority
        • tcpRoute
          • action required
            • weightedTargets required
          • timeout
            • idle
      • status required
        • status required
      • virtualRouterName required

DeleteVirtualGatewayInput

  • DeleteVirtualGatewayInput object

DeleteVirtualGatewayOutput

  • DeleteVirtualGatewayOutput object

DeleteVirtualNodeInput

  • DeleteVirtualNodeInput object: <zonbook></zonbook><xhtml></xhtml>

DeleteVirtualNodeOutput

  • DeleteVirtualNodeOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualNode required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • backendDefaults
          • clientPolicy
            • tls
        • backends
        • listeners
        • logging
          • accessLog
            • file
        • serviceDiscovery
          • awsCloudMap
            • attributes
            • namespaceName required
            • serviceName required
          • dns
            • hostname required
      • status required
        • status required
      • virtualNodeName required

DeleteVirtualRouterInput

  • DeleteVirtualRouterInput object: <zonbook></zonbook><xhtml></xhtml>

DeleteVirtualRouterOutput

  • DeleteVirtualRouterOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualRouter required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
      • status required
        • status required
      • virtualRouterName required

DeleteVirtualServiceInput

  • DeleteVirtualServiceInput object: <zonbook></zonbook><xhtml></xhtml>

DeleteVirtualServiceOutput

  • DeleteVirtualServiceOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualService required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • provider
          • virtualNode
            • virtualNodeName required
          • virtualRouter
            • virtualRouterName required
      • status required
        • status required
      • virtualServiceName required

DescribeGatewayRouteInput

  • DescribeGatewayRouteInput object

DescribeGatewayRouteOutput

  • DescribeGatewayRouteOutput object
    • gatewayRoute required
      • gatewayRouteName required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • grpcRoute
          • action required
            • target required
          • match required
            • serviceName
        • http2Route
          • action required
            • target required
          • match required
            • prefix required
        • httpRoute
          • action required
            • target required
          • match required
            • prefix required
      • status required
        • status required
      • virtualGatewayName required

DescribeMeshInput

  • DescribeMeshInput object: <zonbook></zonbook><xhtml></xhtml>

DescribeMeshOutput

  • DescribeMeshOutput object: <zonbook></zonbook><xhtml></xhtml>
    • mesh required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • egressFilter
          • type required
      • status required
        • status

DescribeRouteInput

  • DescribeRouteInput object: <zonbook></zonbook><xhtml></xhtml>

DescribeRouteOutput

  • DescribeRouteOutput object: <zonbook></zonbook><xhtml></xhtml>
    • route required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • routeName required
      • spec required
        • grpcRoute
          • action required
            • weightedTargets required
          • match required
            • metadata
            • methodName
            • serviceName
          • retryPolicy
            • grpcRetryEvents
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • http2Route
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • httpRoute
          • action required
            • weightedTargets required
          • match required
            • headers
            • method
            • prefix required
            • scheme
          • retryPolicy
            • httpRetryEvents
            • maxRetries required
            • perRetryTimeout required
            • tcpRetryEvents
          • timeout
            • idle
            • perRequest
        • priority
        • tcpRoute
          • action required
            • weightedTargets required
          • timeout
            • idle
      • status required
        • status required
      • virtualRouterName required

DescribeVirtualGatewayInput

  • DescribeVirtualGatewayInput object

DescribeVirtualGatewayOutput

  • DescribeVirtualGatewayOutput object

DescribeVirtualNodeInput

  • DescribeVirtualNodeInput object: <zonbook></zonbook><xhtml></xhtml>

DescribeVirtualNodeOutput

  • DescribeVirtualNodeOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualNode required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
        • backendDefaults
          • clientPolicy
            • tls
        • backends
        • listeners
        • logging
          • accessLog
            • file
        • serviceDiscovery
          • awsCloudMap
            • attributes
            • namespaceName required
            • serviceName required
          • dns
            • hostname required
      • status required
        • status required
      • virtualNodeName required

DescribeVirtualRouterInput

  • DescribeVirtualRouterInput object: <zonbook></zonbook><xhtml></xhtml>

DescribeVirtualRouterOutput

  • DescribeVirtualRouterOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualRouter required
      • meshName required
      • metadata required
        • arn required
        • createdAt required
        • lastUpdatedAt required
        • meshOwner required
        • resourceOwner required
        • uid required
        • version required
      • spec required
      • status required
        • status required
      • virtualRouterName required

DescribeVirtualServiceInput

  • DescribeVirtualServiceInput object: <zonbook></zonbook><xhtml></xhtml>

DescribeVirtualServiceOutput

  • DescribeVirtualServiceOutput object: <zonbook></zonbook><xhtml></xhtml>
    • virtualService required
      • meshName required
      • metadata required ResourceMetadata
      • spec required
        • provider
          • virtualNode
            • virtualNodeName required
          • virtualRouter
            • virtualRouterName required
      • status required
        • status required
      • virtualServiceName required

DnsServiceDiscovery

  • DnsServiceDiscovery object: An object that represents the DNS service discovery information for your virtual node.
    • hostname required

Duration

  • Duration object: An object that represents a duration of time.
    • unit
    • value

DurationUnit

  • DurationUnit string (values: s, ms)

DurationValue

  • DurationValue integer

EgressFilter

  • EgressFilter object: An object that represents the egress filter rules for a service mesh.
    • type required

EgressFilterType

  • EgressFilterType string (values: ALLOW_ALL, DROP_ALL)

FileAccessLog

  • FileAccessLog object: An object that represents an access log file.
    • path required

FilePath

  • FilePath string

ForbiddenException

GatewayRouteData

  • GatewayRouteData object: An object that represents a gateway route returned by a describe operation.
    • gatewayRouteName required
    • meshName required
    • metadata required ResourceMetadata
    • spec required
      • grpcRoute
        • action required
          • target required
            • virtualService required
        • match required
          • serviceName
      • http2Route
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required
      • httpRoute
        • action required
          • target required
            • virtualService required
        • match required
          • prefix required
    • status required
      • status required
    • virtualGatewayName required

GatewayRouteList

GatewayRouteRef

  • GatewayRouteRef object: An object that represents a gateway route returned by a list operation.
    • arn required
    • createdAt required
    • gatewayRouteName required
    • lastUpdatedAt required
    • meshName required
    • meshOwner required
    • resourceOwner required
    • version required
    • virtualGatewayName required

GatewayRouteSpec

  • GatewayRouteSpec object: An object that represents a gateway route specification. Specify one gateway route type.
    • grpcRoute
      • action required
        • target required
          • virtualService required
            • virtualServiceName required
      • match required
        • serviceName
    • http2Route
      • action required
        • target required
          • virtualService required
            • virtualServiceName required
      • match required
        • prefix required
    • httpRoute
      • action required
        • target required
          • virtualService required
            • virtualServiceName required
      • match required
        • prefix required

GatewayRouteStatus

  • GatewayRouteStatus object: An object that represents the current status of a gateway route.
    • status required

GatewayRouteStatusCode

  • GatewayRouteStatusCode string (values: ACTIVE, INACTIVE, DELETED)

GatewayRouteTarget

  • GatewayRouteTarget object: An object that represents a gateway route target.
    • virtualService required
      • virtualServiceName required

GatewayRouteVirtualService

  • GatewayRouteVirtualService object: An object that represents the virtual service that traffic is routed to.
    • virtualServiceName required

GrpcGatewayRoute

  • GrpcGatewayRoute object: An object that represents a gRPC gateway route.
    • action required
      • target required
        • virtualService required
          • virtualServiceName required
    • match required
      • serviceName

GrpcGatewayRouteAction

  • GrpcGatewayRouteAction object: An object that represents the action to take if a match is determined.
    • target required
      • virtualService required
        • virtualServiceName required

GrpcGatewayRouteMatch

  • GrpcGatewayRouteMatch object: An object that represents the criteria for determining a request match.
    • serviceName

GrpcRetryPolicy

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

GrpcRetryPolicyEvent

  • GrpcRetryPolicyEvent string (values: cancelled, deadline-exceeded, internal, resource-exhausted, unavailable)

GrpcRetryPolicyEvents

GrpcRoute

GrpcRouteAction

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

GrpcRouteMatch

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

GrpcRouteMetadata

  • GrpcRouteMetadata object: An object that represents the match metadata for the route.
    • invert
    • match
      • exact
      • prefix
      • range
        • end required
        • start required
      • regex
      • suffix
    • name required

GrpcRouteMetadataList

GrpcRouteMetadataMatchMethod

  • GrpcRouteMetadataMatchMethod object: An object that represents the match method. Specify one of the match values.
    • exact
    • prefix
    • range
      • end required
      • start required
    • regex
    • suffix

GrpcTimeout

  • GrpcTimeout object: An object that represents types of timeouts.
    • idle
      • unit
      • value
    • perRequest
      • unit
      • value

HeaderMatch

  • HeaderMatch string

HeaderMatchMethod

  • HeaderMatchMethod object: An object that represents the method and value to match with the header value sent in a request. Specify one match method.
    • exact
    • prefix
    • range
      • end required
      • start required
    • regex
    • suffix

HeaderName

  • HeaderName string

HealthCheckIntervalMillis

  • HealthCheckIntervalMillis integer

HealthCheckPolicy

  • HealthCheckPolicy object: An object that represents the health check policy for a virtual node's listener.
    • healthyThreshold required
    • intervalMillis required
    • path
    • port
    • protocol required
    • timeoutMillis required
    • unhealthyThreshold required

HealthCheckThreshold

  • HealthCheckThreshold integer

HealthCheckTimeoutMillis

  • HealthCheckTimeoutMillis integer

Hostname

  • Hostname string

HttpGatewayRoute

  • HttpGatewayRoute object: An object that represents an HTTP gateway route.
    • action required
      • target required
        • virtualService required
          • virtualServiceName required
    • match required
      • prefix required

HttpGatewayRouteAction

  • HttpGatewayRouteAction object: An object that represents the action to take if a match is determined.
    • target required
      • virtualService required
        • virtualServiceName required

HttpGatewayRouteMatch

  • HttpGatewayRouteMatch object: An object that represents the criteria for determining a request match.
    • prefix required

HttpMethod

  • HttpMethod string (values: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH)

HttpRetryPolicy

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

HttpRetryPolicyEvent

  • HttpRetryPolicyEvent string

HttpRetryPolicyEvents

HttpRoute

  • HttpRoute object: An object that represents an HTTP or HTTP/2 route type.
    • action required
      • weightedTargets **