Class: Aws::AppMesh::Types::CreateGatewayRouteInput

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-appmesh/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_route_name ⇒ String

The name to use for the gateway route.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_name ⇒ String

The name of the service mesh to create the gateway route in.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :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 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]: docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#spec ⇒ Types::GatewayRouteSpec

The gateway route specification to apply.

Returns:



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::TagRef>

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.

Returns:



304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_gateway_name ⇒ String

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.

Returns:

  • (String) 


304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/aws-sdk-appmesh/types.rb', line 304

class CreateGatewayRouteInput < Struct.new(
  :client_token,
  :gateway_route_name,
  :mesh_name,
  :mesh_owner,
  :spec,
  :tags,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end