2020/07/09 - AWS App Mesh - 10 new api methods
Changes Update appmesh client to latest version
Describes an existing gateway route.
See also: AWS API Documentation
Request Syntax
client.describe_gateway_route( gatewayRouteName='string', meshName='string', meshOwner='string', virtualGatewayName='string' )
string
[REQUIRED]
The name of the gateway route to describe.
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway that the gateway route is associated with.
dict
Response Syntax
{ 'gatewayRoute': { 'gatewayRouteName': 'string', 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
gatewayRoute (dict) --
The full description of your gateway route.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
Describes an existing virtual gateway.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_gateway( meshName='string', meshOwner='string', virtualGatewayName='string' )
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway to describe.
dict
Response Syntax
{ 'virtualGateway': { 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
virtualGateway (dict) --
The full description of your virtual gateway.
meshName (string) --
The name of the service mesh that the virtual gateway resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual gateway.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
trust (dict) --
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Updates an existing gateway route that is associated to a specified virtual gateway in a service mesh.
See also: AWS API Documentation
Request Syntax
client.update_gateway_route( clientToken='string', gatewayRouteName='string', meshName='string', meshOwner='string', spec={ 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, virtualGatewayName='string' )
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the gateway route to update.
string
[REQUIRED]
The name of the service mesh that the gateway route resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new gateway route specification to apply. This overwrites the existing data.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
prefix (string) -- [REQUIRED]
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
prefix (string) -- [REQUIRED]
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
string
[REQUIRED]
The name of the virtual gateway that the gateway route is associated with.
dict
Response Syntax
{ 'gatewayRoute': { 'gatewayRouteName': 'string', 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
gatewayRoute (dict) --
A full description of the gateway route that was updated.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
Updates an existing virtual gateway in a specified service mesh.
See also: AWS API Documentation
Request Syntax
client.update_virtual_gateway( clientToken='string', meshName='string', meshOwner='string', spec={ 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, virtualGatewayName='string' )
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh that the virtual gateway resides in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The new virtual gateway specification to apply. This overwrites the existing data.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
trust (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) -- [REQUIRED]
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping. Specify one protocol.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) -- [REQUIRED]
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) -- [REQUIRED]
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
string
[REQUIRED]
The name of the virtual gateway to update.
dict
Response Syntax
{ 'virtualGateway': { 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
virtualGateway (dict) --
A full description of the virtual gateway that was updated.
meshName (string) --
The name of the service mesh that the virtual gateway resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual gateway.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
trust (dict) --
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway routes are associated to it.
See also: AWS API Documentation
Request Syntax
client.delete_virtual_gateway( meshName='string', meshOwner='string', virtualGatewayName='string' )
string
[REQUIRED]
The name of the service mesh to delete the virtual gateway from.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway to delete.
dict
Response Syntax
{ 'virtualGateway': { 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
virtualGateway (dict) --
The virtual gateway that was deleted.
meshName (string) --
The name of the service mesh that the virtual gateway resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual gateway.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
trust (dict) --
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.
Returns a list of existing gateway routes that are associated to a virtual gateway.
See also: AWS API Documentation
Request Syntax
client.list_gateway_routes( limit=123, meshName='string', meshOwner='string', nextToken='string', virtualGatewayName='string' )
integer
limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.
string
[REQUIRED]
The name of the service mesh to list gateway routes in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
string
[REQUIRED]
The name of the virtual gateway to list gateway routes in.
dict
Response Syntax
{ 'gatewayRoutes': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'gatewayRouteName': 'string', 'lastUpdatedAt': datetime(2015, 1, 1), 'meshName': 'string', 'meshOwner': 'string', 'resourceOwner': 'string', 'version': 123, 'virtualGatewayName': 'string' }, ], 'nextToken': 'string' }
Response Structure
(dict) --
gatewayRoutes (list) --
The list of existing gateway routes for the specified service mesh and virtual gateway.
(dict) --
An object that represents a gateway route returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the gateway route.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
gatewayRouteName (string) --
The name of the gateway route.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
nextToken (string) --
limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
Deletes an existing gateway route.
See also: AWS API Documentation
Request Syntax
client.delete_gateway_route( gatewayRouteName='string', meshName='string', meshOwner='string', virtualGatewayName='string' )
string
[REQUIRED]
The name of the gateway route to delete.
string
[REQUIRED]
The name of the service mesh to delete the gateway route from.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
[REQUIRED]
The name of the virtual gateway to delete the route from.
dict
Response Syntax
{ 'gatewayRoute': { 'gatewayRouteName': 'string', 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
gatewayRoute (dict) --
The gateway route that was deleted.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
Returns a list of existing virtual gateways in a service mesh.
See also: AWS API Documentation
Request Syntax
client.list_virtual_gateways( limit=123, meshName='string', meshOwner='string', nextToken='string' )
integer
limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListVirtualGateways request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListVirtualGateways returns up to 100 results and a nextToken value if applicable.
string
[REQUIRED]
The name of the service mesh to list virtual gateways in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
string
ListVirtualGateways request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.
dict
Response Syntax
{ 'nextToken': 'string', 'virtualGateways': [ { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshName': 'string', 'meshOwner': 'string', 'resourceOwner': 'string', 'version': 123, 'virtualGatewayName': 'string' }, ] }
Response Structure
(dict) --
nextToken (string) --
limit, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
virtualGateways (list) --
The list of existing virtual gateways for the specified service mesh.
(dict) --
An object that represents a virtual gateway returned by a list operation.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshName (string) --
The name of the service mesh that the resource resides in.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
virtualGatewayName (string) --
The name of the resource.
Creates a gateway route.
A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.
For more information about gateway routes, see Gateway routes.
See also: AWS API Documentation
Request Syntax
client.create_gateway_route( clientToken='string', gatewayRouteName='string', meshName='string', meshOwner='string', spec={ 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, tags=[ { 'key': 'string', 'value': 'string' }, ], virtualGatewayName='string' )
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name to use for the gateway route.
string
[REQUIRED]
The name of the service mesh to create the gateway route in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The gateway route specification to apply.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
prefix (string) -- [REQUIRED]
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) -- [REQUIRED]
An object that represents the action to take if a match is determined.
target (dict) -- [REQUIRED]
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) -- [REQUIRED]
An object that represents a virtual service gateway route target.
virtualServiceName (string) -- [REQUIRED]
The name of the virtual service that traffic is routed to.
match (dict) -- [REQUIRED]
An object that represents the criteria for determining a request match.
prefix (string) -- [REQUIRED]
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
list
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.
(dict) --
Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
dict
Response Syntax
{ 'gatewayRoute': { 'gatewayRouteName': 'string', 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'grpcRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'serviceName': 'string' } }, 'http2Route': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } }, 'httpRoute': { 'action': { 'target': { 'virtualService': { 'virtualServiceName': 'string' } } }, 'match': { 'prefix': 'string' } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
gatewayRoute (dict) --
The full description of your gateway route following the create call.
gatewayRouteName (string) --
The name of the gateway route.
meshName (string) --
The name of the service mesh that the resource resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the gateway route.
grpcRoute (dict) --
An object that represents the specification of a gRPC gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
serviceName (string) --
The fully qualified domain name for the service to match from the request.
http2Route (dict) --
An object that represents the specification of an HTTP/2 gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
httpRoute (dict) --
An object that represents the specification of an HTTP gateway route.
action (dict) --
An object that represents the action to take if a match is determined.
target (dict) --
An object that represents the target that traffic is routed to when a request matches the gateway route.
virtualService (dict) --
An object that represents a virtual service gateway route target.
virtualServiceName (string) --
The name of the virtual service that traffic is routed to.
match (dict) --
An object that represents the criteria for determining a request match.
prefix (string) --
Specifies the path to match requests with. This parameter must always start with
/, which by itself matches all requests to the virtual service name. You can also match for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be
/metrics.
status (dict) --
The status of the gateway route.
status (string) --
The current status for the gateway route.
virtualGatewayName (string) --
The virtual gateway that the gateway route is associated with.
Creates a virtual gateway.
A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.
For more information about virtual gateways, see Virtual gateways.
See also: AWS API Documentation
Request Syntax
client.create_virtual_gateway( clientToken='string', meshName='string', meshOwner='string', spec={ 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, tags=[ { 'key': 'string', 'value': 'string' }, ], virtualGatewayName='string' )
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.
This field is autopopulated if not provided.
string
[REQUIRED]
The name of the service mesh to create the virtual gateway in.
string
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.
dict
[REQUIRED]
The virtual gateway specification to apply.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context.
trust (dict) -- [REQUIRED]
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) -- [REQUIRED]
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) -- [REQUIRED]
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) -- [REQUIRED]
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) -- [REQUIRED]
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) -- [REQUIRED]
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) -- [REQUIRED]
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) -- [REQUIRED]
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) -- [REQUIRED]
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) -- [REQUIRED]
The port mapping information for the listener.
port (integer) -- [REQUIRED]
The port used for the port mapping. Specify one protocol.
protocol (string) -- [REQUIRED]
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) -- [REQUIRED]
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) -- [REQUIRED]
The certificate chain for the certificate.
privateKey (string) -- [REQUIRED]
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) -- [REQUIRED]
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) -- [REQUIRED]
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
list
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.
(dict) --
Optional metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
key (string) -- [REQUIRED]
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
string
[REQUIRED]
The name to use for the virtual gateway.
dict
Response Syntax
{ 'virtualGateway': { 'meshName': 'string', 'metadata': { 'arn': 'string', 'createdAt': datetime(2015, 1, 1), 'lastUpdatedAt': datetime(2015, 1, 1), 'meshOwner': 'string', 'resourceOwner': 'string', 'uid': 'string', 'version': 123 }, 'spec': { 'backendDefaults': { 'clientPolicy': { 'tls': { 'enforce': True|False, 'ports': [ 123, ], 'validation': { 'trust': { 'acm': { 'certificateAuthorityArns': [ 'string', ] }, 'file': { 'certificateChain': 'string' } } } } } }, 'listeners': [ { 'healthCheck': { 'healthyThreshold': 123, 'intervalMillis': 123, 'path': 'string', 'port': 123, 'protocol': 'grpc'|'http'|'http2', 'timeoutMillis': 123, 'unhealthyThreshold': 123 }, 'portMapping': { 'port': 123, 'protocol': 'grpc'|'http'|'http2' }, 'tls': { 'certificate': { 'acm': { 'certificateArn': 'string' }, 'file': { 'certificateChain': 'string', 'privateKey': 'string' } }, 'mode': 'DISABLED'|'PERMISSIVE'|'STRICT' } }, ], 'logging': { 'accessLog': { 'file': { 'path': 'string' } } } }, 'status': { 'status': 'ACTIVE'|'DELETED'|'INACTIVE' }, 'virtualGatewayName': 'string' } }
Response Structure
(dict) --
virtualGateway (dict) --
The full description of your virtual gateway following the create call.
meshName (string) --
The name of the service mesh that the virtual gateway resides in.
metadata (dict) --
An object that represents metadata for a resource.
arn (string) --
The full Amazon Resource Name (ARN) for the resource.
createdAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was created.
lastUpdatedAt (datetime) --
The Unix epoch timestamp in seconds for when the resource was last updated.
meshOwner (string) --
The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.
resourceOwner (string) --
The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.
uid (string) --
The unique identifier for the resource.
version (integer) --
The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.
spec (dict) --
The specifications of the virtual gateway.
backendDefaults (dict) --
A reference to an object that represents the defaults for backends.
clientPolicy (dict) --
A reference to an object that represents a client policy.
tls (dict) --
A reference to an object that represents a Transport Layer Security (TLS) client policy.
enforce (boolean) --
Whether the policy is enforced. The default is True, if a value isn't specified.
ports (list) --
One or more ports that the policy is enforced for.
(integer) --
validation (dict) --
A reference to an object that represents a TLS validation context.
trust (dict) --
A reference to an object that represents a TLS validation context trust.
acm (dict) --
A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM) certificate.
certificateAuthorityArns (list) --
One or more ACM Amazon Resource Name (ARN)s.
(string) --
file (dict) --
An object that represents a TLS validation context trust for a local file.
certificateChain (string) --
The certificate trust chain for a certificate stored on the file system of the virtual node that the proxy is running on.
listeners (list) --
The listeners that the mesh endpoint is expected to receive inbound traffic from. You can specify one listener.
(dict) --
An object that represents a listener for a virtual gateway.
healthCheck (dict) --
The health check information for the listener.
healthyThreshold (integer) --
The number of consecutive successful health checks that must occur before declaring the listener healthy.
intervalMillis (integer) --
The time period in milliseconds between each health check execution.
path (string) --
The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.
port (integer) --
The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.
protocol (string) --
The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.
timeoutMillis (integer) --
The amount of time to wait when receiving a response from the health check, in milliseconds.
unhealthyThreshold (integer) --
The number of consecutive failed health checks that must occur before declaring a virtual gateway unhealthy.
portMapping (dict) --
The port mapping information for the listener.
port (integer) --
The port used for the port mapping. Specify one protocol.
protocol (string) --
The protocol used for the port mapping.
tls (dict) --
A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.
certificate (dict) --
An object that represents a Transport Layer Security (TLS) certificate.
acm (dict) --
A reference to an object that represents an AWS Certicate Manager (ACM) certificate.
certificateArn (string) --
The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).
file (dict) --
A reference to an object that represents a local file certificate.
certificateChain (string) --
The certificate chain for the certificate.
privateKey (string) --
The private key for a certificate stored on the file system of the mesh endpoint that the proxy is running on.
mode (string) --
Specify one of the following modes.
STRICT – Listener only accepts connections with TLS enabled.
PERMISSIVE – Listener accepts connections with or without TLS enabled.
DISABLED – Listener only accepts connections without TLS.
logging (dict) --
An object that represents logging information.
accessLog (dict) --
The access log configuration.
file (dict) --
The file object to send virtual gateway access logs to.
path (string) --
The file path to write access logs to. You can use /dev/stdout to send access logs to standard out and configure your Envoy container to use a log driver, such as
awslogs, to export the access logs to a log storage service such as Amazon CloudWatch Logs. You can also specify a path in the Envoy container's file system to write the files to disk.
status (dict) --
The current status of the virtual gateway.
status (string) --
The current status.
virtualGatewayName (string) --
The name of the virtual gateway.