Class: Aws::AppMesh::Types::UpdateGatewayRouteInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppMesh::Types::UpdateGatewayRouteInput
- Defined in:
- gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb
Overview
When making an API call, you may pass UpdateGatewayRouteInput 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,
},
virtual_gateway_name: "ResourceName", # required
}
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#client_token ⇒ String
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
-
#gateway_route_name ⇒ String
The name of the gateway route to update.
-
#mesh_name ⇒ String
The name of the service mesh that the gateway route resides in.
-
#mesh_owner ⇒ String
The Amazon Web Services IAM account ID of the service mesh owner.
-
#spec ⇒ Types::GatewayRouteSpec
The new gateway route specification to apply.
-
#virtual_gateway_name ⇒ String
The name of the virtual gateway that the gateway route is associated with.
Instance Attribute Details
#client_token ⇒ 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.
A suitable default value is auto-generated. You should normally not need to pass this option.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |
#gateway_route_name ⇒ String
The name of the gateway route to update.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |
#mesh_name ⇒ String
The name of the service mesh that the gateway route resides in.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |
#mesh_owner ⇒ String
The Amazon Web Services 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.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |
#spec ⇒ Types::GatewayRouteSpec
The new gateway route specification to apply. This overwrites the existing data.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |
#virtual_gateway_name ⇒ String
The name of the virtual gateway that the gateway route is associated with.
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 7102 class UpdateGatewayRouteInput < Struct.new( :client_token, :gateway_route_name, :mesh_name, :mesh_owner, :spec, :virtual_gateway_name) SENSITIVE = [] include Aws::Structure end |