class Aws::AppMesh::Types::CreateGatewayRouteInput
@note When making an API call, you may pass CreateGatewayRouteInput
data as a hash: { client_token: "String", gateway_route_name: "ResourceName", # required mesh_name: "ResourceName", # required mesh_owner: "AccountId", spec: { # required grpc_route: { action: { # required rewrite: { hostname: { default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED }, }, target: { # required virtual_service: { # required virtual_service_name: "ResourceName", # required }, }, }, match: { # required hostname: { exact: "ExactHostName", suffix: "SuffixHostname", }, metadata: [ { invert: false, match: { exact: "HeaderMatch", prefix: "HeaderMatch", range: { end: 1, # required start: 1, # required }, regex: "HeaderMatch", suffix: "HeaderMatch", }, name: "HeaderName", # required }, ], service_name: "ServiceName", }, }, http2_route: { action: { # required rewrite: { hostname: { default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED }, path: { exact: "HttpPathExact", }, prefix: { default_prefix: "ENABLED", # accepts ENABLED, DISABLED value: "HttpGatewayRoutePrefix", }, }, target: { # required virtual_service: { # required virtual_service_name: "ResourceName", # required }, }, }, match: { # required headers: [ { invert: false, match: { exact: "HeaderMatch", prefix: "HeaderMatch", range: { end: 1, # required start: 1, # required }, regex: "HeaderMatch", suffix: "HeaderMatch", }, name: "HeaderName", # required }, ], hostname: { exact: "ExactHostName", suffix: "SuffixHostname", }, method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH path: { exact: "HttpPathExact", regex: "HttpPathRegex", }, prefix: "String", query_parameters: [ { match: { exact: "String", }, name: "QueryParameterName", # required }, ], }, }, http_route: { action: { # required rewrite: { hostname: { default_target_hostname: "ENABLED", # accepts ENABLED, DISABLED }, path: { exact: "HttpPathExact", }, prefix: { default_prefix: "ENABLED", # accepts ENABLED, DISABLED value: "HttpGatewayRoutePrefix", }, }, target: { # required virtual_service: { # required virtual_service_name: "ResourceName", # required }, }, }, match: { # required headers: [ { invert: false, match: { exact: "HeaderMatch", prefix: "HeaderMatch", range: { end: 1, # required start: 1, # required }, regex: "HeaderMatch", suffix: "HeaderMatch", }, name: "HeaderName", # required }, ], hostname: { exact: "ExactHostName", suffix: "SuffixHostname", }, method: "GET", # accepts GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE, PATCH path: { exact: "HttpPathExact", regex: "HttpPathRegex", }, prefix: "String", query_parameters: [ { match: { exact: "String", }, name: "QueryParameterName", # required }, ], }, }, priority: 1, }, tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], virtual_gateway_name: "ResourceName", # required }
@!attribute [rw] client_token
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed. **A suitable default value is auto-generated.** You should normally not need to pass this option. @return [String]
@!attribute [rw] gateway_route_name
The name to use for the gateway route. @return [String]
@!attribute [rw] mesh_name
The name of the service mesh to create the gateway route in. @return [String]
@!attribute [rw] mesh_owner
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][1]. [1]: https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html @return [String]
@!attribute [rw] spec
The gateway route specification to apply. @return [Types::GatewayRouteSpec]
@!attribute [rw] tags
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. @return [Array<Types::TagRef>]
@!attribute [rw] virtual_gateway_name
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. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/appmesh-2019-01-25/CreateGatewayRouteInput AWS API Documentation
Constants
- SENSITIVE