@datafire/amazonaws_appmesh
v5.0.0
Published
DataFire integration for AWS App Mesh
Downloads
7
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
Actions
ListMeshes
amazonaws_appmesh.ListMeshes({}, context)
Input
- input
object
- limit
integer
- nextToken
string
- limit
Output
- output ListMeshesOutput
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.- items TagRef
- 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
- egressFilter
- tags
Output
- output CreateMeshOutput
DeleteMesh
amazonaws_appmesh.DeleteMesh({
"meshName": ""
}, context)
Input
- input
object
- meshName required
string
- meshName required
Output
- output DeleteMeshOutput
DescribeMesh
amazonaws_appmesh.DescribeMesh({
"meshName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- meshName required
Output
- output DescribeMeshOutput
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
- egressFilter
- meshName required
Output
- output UpdateMeshOutput
ListGatewayRoutes
amazonaws_appmesh.ListGatewayRoutes({
"meshName": "",
"virtualGatewayName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- virtualGatewayName required
string
- limit
Output
- output ListGatewayRoutesOutput
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.- items TagRef
- 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
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- grpcRoute
- meshName required
Output
- output CreateGatewayRouteOutput
DeleteGatewayRoute
amazonaws_appmesh.DeleteGatewayRoute({
"gatewayRouteName": "",
"meshName": "",
"virtualGatewayName": ""
}, context)
Input
- input
object
- gatewayRouteName required
string
- meshName required
string
- meshOwner
string
- virtualGatewayName required
string
- gatewayRouteName required
Output
- output DeleteGatewayRouteOutput
DescribeGatewayRoute
amazonaws_appmesh.DescribeGatewayRoute({
"gatewayRouteName": "",
"meshName": "",
"virtualGatewayName": ""
}, context)
Input
- input
object
- gatewayRouteName required
string
- meshName required
string
- meshOwner
string
- virtualGatewayName required
string
- gatewayRouteName required
Output
- output DescribeGatewayRouteOutput
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
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- grpcRoute
- gatewayRouteName required
Output
- output UpdateGatewayRouteOutput
ListVirtualGateways
amazonaws_appmesh.ListVirtualGateways({
"meshName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- limit
Output
- output ListVirtualGatewaysOutput
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.- items TagRef
- 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.- backendDefaults
- clientPolicy
- tls
- enforce
- ports
- validation required
- tls
- clientPolicy
- listeners
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- virtualGatewayName required
string
: The name to use for the virtual gateway.
- meshName required
Output
- output CreateVirtualGatewayOutput
DeleteVirtualGateway
amazonaws_appmesh.DeleteVirtualGateway({
"meshName": "",
"virtualGatewayName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualGatewayName required
string
- meshName required
Output
- output DeleteVirtualGatewayOutput
DescribeVirtualGateway
amazonaws_appmesh.DescribeVirtualGateway({
"meshName": "",
"virtualGatewayName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualGatewayName required
string
- meshName required
Output
- output DescribeVirtualGatewayOutput
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.- backendDefaults
- clientPolicy
- tls
- enforce
- ports
- validation required
- tls
- clientPolicy
- listeners
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- meshName required
Output
- output UpdateVirtualGatewayOutput
ListVirtualNodes
amazonaws_appmesh.ListVirtualNodes({
"meshName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- limit
Output
- output ListVirtualNodesOutput
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.- items TagRef
- 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. - virtualNodeName required
string
: The name to use for the virtual node.
- meshName required
Output
- output CreateVirtualNodeOutput
DeleteVirtualNode
amazonaws_appmesh.DeleteVirtualNode({
"meshName": "",
"virtualNodeName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualNodeName required
string
- meshName required
Output
- output DeleteVirtualNodeOutput
DescribeVirtualNode
amazonaws_appmesh.DescribeVirtualNode({
"meshName": "",
"virtualNodeName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualNodeName required
string
- meshName required
Output
- output DescribeVirtualNodeOutput
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.
- meshName required
Output
- output UpdateVirtualNodeOutput
ListRoutes
amazonaws_appmesh.ListRoutes({
"meshName": "",
"virtualRouterName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- virtualRouterName required
string
- limit
Output
- output ListRoutesOutput
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.- items TagRef
- 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.- grpcRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- metadata
- items GrpcRouteMetadata
- methodName
- serviceName
- metadata
- retryPolicy
- grpcRetryEvents
- items GrpcRetryPolicyEvent
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- grpcRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- http2Route
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- httpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- timeout
- idle
- unit
- value
- idle
- action required
- grpcRoute
- meshName required
Output
- output CreateRouteOutput
DeleteRoute
amazonaws_appmesh.DeleteRoute({
"meshName": "",
"routeName": "",
"virtualRouterName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- routeName required
string
- virtualRouterName required
string
- meshName required
Output
- output DeleteRouteOutput
DescribeRoute
amazonaws_appmesh.DescribeRoute({
"meshName": "",
"routeName": "",
"virtualRouterName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- routeName required
string
- virtualRouterName required
string
- meshName required
Output
- output DescribeRouteOutput
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.- grpcRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- metadata
- items GrpcRouteMetadata
- methodName
- serviceName
- metadata
- retryPolicy
- grpcRetryEvents
- items GrpcRetryPolicyEvent
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- grpcRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- http2Route
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- httpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- timeout
- idle
- unit
- value
- idle
- action required
- grpcRoute
- meshName required
Output
- output UpdateRouteOutput
ListVirtualRouters
amazonaws_appmesh.ListVirtualRouters({
"meshName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- limit
Output
- output ListVirtualRoutersOutput
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.- items TagRef
- 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.- listeners
- items VirtualRouterListener
- listeners
- virtualRouterName required
string
: The name to use for the virtual router.
- meshName required
Output
- output CreateVirtualRouterOutput
DeleteVirtualRouter
amazonaws_appmesh.DeleteVirtualRouter({
"meshName": "",
"virtualRouterName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualRouterName required
string
- meshName required
Output
- output DeleteVirtualRouterOutput
DescribeVirtualRouter
amazonaws_appmesh.DescribeVirtualRouter({
"meshName": "",
"virtualRouterName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualRouterName required
string
- meshName required
Output
- output DescribeVirtualRouterOutput
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.- listeners
- items VirtualRouterListener
- listeners
- meshName required
Output
- output UpdateVirtualRouterOutput
ListVirtualServices
amazonaws_appmesh.ListVirtualServices({
"meshName": ""
}, context)
Input
- input
object
- limit
integer
- meshName required
string
- meshOwner
string
- nextToken
string
- limit
Output
- output ListVirtualServicesOutput
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.- items TagRef
- 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
- virtualNode
- provider
- virtualServiceName required
string
: The name to use for the virtual service.
- meshName required
Output
- output CreateVirtualServiceOutput
DeleteVirtualService
amazonaws_appmesh.DeleteVirtualService({
"meshName": "",
"virtualServiceName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualServiceName required
string
- meshName required
Output
- output DeleteVirtualServiceOutput
DescribeVirtualService
amazonaws_appmesh.DescribeVirtualService({
"meshName": "",
"virtualServiceName": ""
}, context)
Input
- input
object
- meshName required
string
- meshOwner
string
- virtualServiceName required
string
- meshName required
Output
- output DescribeVirtualServiceOutput
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
- virtualNode
- provider
- meshName required
Output
- output UpdateVirtualServiceOutput
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.- items TagRef
- resourceArn required
Output
- output TagResourceOutput
ListTagsForResource
amazonaws_appmesh.ListTagsForResource({
"resourceArn": ""
}, context)
Input
- input
object
- limit
integer
- nextToken
string
- resourceArn required
string
- limit
Output
- output ListTagsForResourceOutput
UntagResource
amazonaws_appmesh.UntagResource({
"resourceArn": "",
"tagKeys": []
}, context)
Input
- input
object
- resourceArn required
string
- tagKeys required
array
: The keys of the tags to be removed.- items TagKey
- resourceArn required
Output
- output UntagResourceOutput
Definitions
AccessLog
- AccessLog
object
: An object that represents the access logging information for a virtual node.- file
- path required
- file
AccountId
- AccountId
string
Arn
- Arn
string
AwsCloudMapInstanceAttribute
- AwsCloudMapInstanceAttribute
object
: An object that represents the AWS Cloud Map attribute information for your virtual node. AWS Cloud Map is not available in the eu-south-1 Region.- key required
- value required
AwsCloudMapInstanceAttributeKey
- AwsCloudMapInstanceAttributeKey
string
AwsCloudMapInstanceAttributeValue
- AwsCloudMapInstanceAttributeValue
string
AwsCloudMapInstanceAttributes
- AwsCloudMapInstanceAttributes
array
AwsCloudMapName
- AwsCloudMapName
string
AwsCloudMapServiceDiscovery
- AwsCloudMapServiceDiscovery
object
: An object that represents the AWS Cloud Map service discovery information for your virtual node. AWS Cloud Map is not available in the eu-south-1 Region.- attributes
- namespaceName required
- serviceName required
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
- items PortNumber
- validation required
- trust required
- tls
- virtualServiceName required
- clientPolicy
- virtualService
BackendDefaults
- BackendDefaults
object
: An object that represents the default properties for a backend.- clientPolicy
- tls
- enforce
- ports
- items PortNumber
- validation required
- trust required
- acm
- file
- trust required
- tls
- clientPolicy
Backends
- Backends
array
- items Backend
BadRequestException
Boolean
- Boolean
boolean
CertificateAuthorityArns
- CertificateAuthorityArns
array
- items Arn
ClientPolicy
- ClientPolicy
object
: An object that represents a client policy.- tls
- enforce
- ports
- items PortNumber
- validation required
- trust required
- acm
- certificateAuthorityArns required
- file
- certificateChain required
- acm
- trust required
- tls
ClientPolicyTls
- ClientPolicyTls
object
: A reference to an object that represents a Transport Layer Security (TLS) client policy.- enforce
- ports
- items PortNumber
- validation required
- trust required
- acm
- certificateAuthorityArns required
- items Arn
- certificateAuthorityArns required
- file
- certificateChain required
- acm
- trust required
ConflictException
CreateGatewayRouteInput
- CreateGatewayRouteInput
object
- tags
- items TagRef
- clientToken
- gatewayRouteName required
- spec required
- grpcRoute
- action required
- target required
- virtualService required
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- grpcRoute
- tags
CreateGatewayRouteOutput
- CreateGatewayRouteOutput
object
- gatewayRoute required
- gatewayRouteName required
- meshName required
- metadata required ResourceMetadata
- spec required
- grpcRoute
- action required
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- match required
- prefix required
- action required
- grpcRoute
- status required
- status required
- virtualGatewayName required
- gatewayRoute required
CreateMeshInput
- CreateMeshInput
object
:- tags
- items TagRef
- clientToken
- meshName required
- spec
- egressFilter
- type required
- egressFilter
- tags
CreateMeshOutput
- CreateMeshOutput
object
:- 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
- egressFilter
- status required
- status
- mesh required
CreateRouteInput
- CreateRouteInput
object
:- tags
- items TagRef
- clientToken
- routeName required
- spec required
- grpcRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- metadata
- items GrpcRouteMetadata
- methodName
- serviceName
- metadata
- retryPolicy
- grpcRetryEvents
- items GrpcRetryPolicyEvent
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- grpcRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- http2Route
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- httpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- headers
- items HttpRouteHeader
- method
- prefix required
- scheme
- headers
- retryPolicy
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- timeout
- idle
- unit
- value
- idle
- action required
- grpcRoute
- tags
CreateRouteOutput
- CreateRouteOutput
object
:- 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
- action required
- http2Route
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- httpRoute
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- timeout
- idle
- action required
- grpcRoute
- status required
- status required
- virtualRouterName required
- route required
CreateVirtualGatewayInput
- CreateVirtualGatewayInput
object
- tags
- items TagRef
- clientToken
- spec required
- backendDefaults
- clientPolicy
- tls
- enforce
- ports
- validation required
- tls
- clientPolicy
- listeners required
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- virtualGatewayName required
- tags
CreateVirtualGatewayOutput
- CreateVirtualGatewayOutput
object
- virtualGateway required
- meshName required
- metadata required ResourceMetadata
- spec required
- backendDefaults
- clientPolicy
- tls
- clientPolicy
- listeners required
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- status required
- status required
- virtualGatewayName required
- virtualGateway required
CreateVirtualNodeInput
- CreateVirtualNodeInput
object
:- tags
- items TagRef
- clientToken
- spec required
- virtualNodeName required
- tags
CreateVirtualNodeOutput
- CreateVirtualNodeOutput
object
:- virtualNode 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
- virtualNodeName required
- virtualNode required
CreateVirtualRouterInput
- CreateVirtualRouterInput
object
:- tags
- items TagRef
- clientToken
- spec required
- listeners
- items VirtualRouterListener
- listeners
- virtualRouterName required
- tags
CreateVirtualRouterOutput
- CreateVirtualRouterOutput
object
:- virtualRouter required
- meshName required
- metadata required
- arn required
- createdAt required
- lastUpdatedAt required
- meshOwner required
- resourceOwner required
- uid required
- version required
- spec required
- listeners
- items VirtualRouterListener
- listeners
- status required
- status required
- virtualRouterName required
- virtualRouter required
CreateVirtualServiceInput
- CreateVirtualServiceInput
object
:- tags
- items TagRef
- clientToken
- spec required
- provider
- virtualNode
- virtualNodeName required
- virtualRouter
- virtualRouterName required
- virtualNode
- provider
- virtualServiceName required
- tags
CreateVirtualServiceOutput
- CreateVirtualServiceOutput
object
:- virtualService required
- meshName required
- metadata required ResourceMetadata
- spec required
- provider
- virtualNode
- virtualNodeName required
- virtualRouter
- virtualRouterName required
- virtualNode
- provider
- status required
- status required
- virtualServiceName required
- virtualService 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
- action required
- http2Route
- action required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- match required
- prefix required
- action required
- grpcRoute
- status required
- status required
- virtualGatewayName required
- gatewayRoute required
DeleteMeshInput
- DeleteMeshInput
object
:
DeleteMeshOutput
- DeleteMeshOutput
object
:- 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
- egressFilter
- status required
- status
- mesh required
DeleteRouteInput
- DeleteRouteInput
object
:
DeleteRouteOutput
- DeleteRouteOutput
object
:- 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
- action required
- http2Route
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- httpRoute
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- timeout
- idle
- action required
- grpcRoute
- status required
- status required
- virtualRouterName required
- route required
DeleteVirtualGatewayInput
- DeleteVirtualGatewayInput
object
DeleteVirtualGatewayOutput
- DeleteVirtualGatewayOutput
object
- virtualGateway required
- meshName required
- metadata required ResourceMetadata
- spec required
- backendDefaults
- clientPolicy
- tls
- clientPolicy
- listeners required
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- status required
- status required
- virtualGatewayName required
- virtualGateway required
DeleteVirtualNodeInput
- DeleteVirtualNodeInput
object
:
DeleteVirtualNodeOutput
- DeleteVirtualNodeOutput
object
:- virtualNode 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
- virtualNodeName required
- virtualNode required
DeleteVirtualRouterInput
- DeleteVirtualRouterInput
object
:
DeleteVirtualRouterOutput
- DeleteVirtualRouterOutput
object
:- virtualRouter required
- meshName required
- metadata required
- arn required
- createdAt required
- lastUpdatedAt required
- meshOwner required
- resourceOwner required
- uid required
- version required
- spec required
- listeners
- items VirtualRouterListener
- listeners
- status required
- status required
- virtualRouterName required
- virtualRouter required
DeleteVirtualServiceInput
- DeleteVirtualServiceInput
object
:
DeleteVirtualServiceOutput
- DeleteVirtualServiceOutput
object
:- virtualService required
- meshName required
- metadata required ResourceMetadata
- spec required
- provider
- virtualNode
- virtualNodeName required
- virtualRouter
- virtualRouterName required
- virtualNode
- provider
- status required
- status required
- virtualServiceName required
- virtualService 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
- action required
- http2Route
- action required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- match required
- prefix required
- action required
- grpcRoute
- status required
- status required
- virtualGatewayName required
- gatewayRoute required
DescribeMeshInput
- DescribeMeshInput
object
:
DescribeMeshOutput
- DescribeMeshOutput
object
:- 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
- egressFilter
- status required
- status
- mesh required
DescribeRouteInput
- DescribeRouteInput
object
:
DescribeRouteOutput
- DescribeRouteOutput
object
:- 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
- action required
- http2Route
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- httpRoute
- action required
- weightedTargets required
- match required
- headers
- method
- prefix required
- scheme
- retryPolicy
- httpRetryEvents
- maxRetries required
- perRetryTimeout required
- tcpRetryEvents
- timeout
- idle
- perRequest
- action required
- priority
- tcpRoute
- action required
- weightedTargets required
- timeout
- idle
- action required
- grpcRoute
- status required
- status required
- virtualRouterName required
- route required
DescribeVirtualGatewayInput
- DescribeVirtualGatewayInput
object
DescribeVirtualGatewayOutput
- DescribeVirtualGatewayOutput
object
- virtualGateway required
- meshName required
- metadata required ResourceMetadata
- spec required
- backendDefaults
- clientPolicy
- tls
- clientPolicy
- listeners required
- items VirtualGatewayListener
- logging VirtualGatewayLogging
- backendDefaults
- status required
- status required
- virtualGatewayName required
- virtualGateway required
DescribeVirtualNodeInput
- DescribeVirtualNodeInput
object
:
DescribeVirtualNodeOutput
- DescribeVirtualNodeOutput
object
:- virtualNode 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
- virtualNodeName required
- virtualNode required
DescribeVirtualRouterInput
- DescribeVirtualRouterInput
object
:
DescribeVirtualRouterOutput
- DescribeVirtualRouterOutput
object
:- virtualRouter required
- meshName required
- metadata required
- arn required
- createdAt required
- lastUpdatedAt required
- meshOwner required
- resourceOwner required
- uid required
- version required
- spec required
- listeners
- items VirtualRouterListener
- listeners
- status required
- status required
- virtualRouterName required
- virtualRouter required
DescribeVirtualServiceInput
- DescribeVirtualServiceInput
object
:
DescribeVirtualServiceOutput
- DescribeVirtualServiceOutput
object
:- virtualService required
- meshName required
- metadata required ResourceMetadata
- spec required
- provider
- virtualNode
- virtualNodeName required
- virtualRouter
- virtualRouterName required
- virtualNode
- provider
- status required
- status required
- virtualServiceName required
- virtualService 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
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- virtualService required
- target required
- match required
- prefix required
- action required
- grpcRoute
- status required
- status required
- virtualGatewayName required
GatewayRouteList
- GatewayRouteList
array
- items GatewayRouteRef
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
- virtualService required
- target required
- match required
- serviceName
- action required
- http2Route
- action required
- target required
- virtualService required
- virtualServiceName required
- virtualService required
- target required
- match required
- prefix required
- action required
- httpRoute
- action required
- target required
- virtualService required
- virtualServiceName required
- virtualService required
- target required
- match required
- prefix required
- action required
- grpcRoute
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
- virtualService 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
- virtualService required
- target required
- match required
- serviceName
- action required
GrpcGatewayRouteAction
- GrpcGatewayRouteAction
object
: An object that represents the action to take if a match is determined.- target required
- virtualService required
- virtualServiceName required
- virtualService required
- target 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.- grpcRetryEvents
- items GrpcRetryPolicyEvent
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- grpcRetryEvents
GrpcRetryPolicyEvent
- GrpcRetryPolicyEvent
string
(values: cancelled, deadline-exceeded, internal, resource-exhausted, unavailable)
GrpcRetryPolicyEvents
- GrpcRetryPolicyEvents
array
- items GrpcRetryPolicyEvent
GrpcRoute
- GrpcRoute
object
: An object that represents a gRPC route type.- action required
- weightedTargets required
- items WeightedTarget
- weightedTargets required
- match required
- metadata
- items GrpcRouteMetadata
- methodName
- serviceName
- metadata
- retryPolicy
- grpcRetryEvents
- items GrpcRetryPolicyEvent
- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- grpcRetryEvents
- timeout
- idle
- unit
- value
- perRequest
- unit
- value
- idle
- action required
GrpcRouteAction
- GrpcRouteAction
object
: An object that represents the action to take if a match is determined.- weightedTargets required
- items WeightedTarget
- weightedTargets required
GrpcRouteMatch
- GrpcRouteMatch
object
: An object that represents the criteria for determining a request match.- metadata
- items GrpcRouteMetadata
- methodName
- serviceName
- metadata
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
- GrpcRouteMetadataList
array
- items GrpcRouteMetadata
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
- idle
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
- virtualService required
- target required
- match required
- prefix required
- action required
HttpGatewayRouteAction
- HttpGatewayRouteAction
object
: An object that represents the action to take if a match is determined.- target required
- virtualService required
- virtualServiceName required
- virtualService required
- target 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.- httpRetryEvents
- items HttpRetryPolicyEvent
- maxRetries required
- perRetryTimeout required
- unit
- value
- tcpRetryEvents
- items TcpRetryPolicyEvent
- httpRetryEvents
HttpRetryPolicyEvent
- HttpRetryPolicyEvent
string
HttpRetryPolicyEvents
- HttpRetryPolicyEvents
array
- items HttpRetryPolicyEvent
HttpRoute
- HttpRoute
object
: An object that represents an HTTP or HTTP/2 route type.- action required
- weightedTargets **
- action required