Class: Aws::AppMesh::Types::CreateRouteInput

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

Overview

<zonbook />

<xhtml />

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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)


438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_nameString

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

Returns:

  • (String)


438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_ownerString

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)


438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#route_nameString

The name to use for the route.

Returns:

  • (String)


438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#specTypes::RouteSpec

The route specification to apply.

Returns:



438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::TagRef>

Optional metadata that you can apply to the route to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:



438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_router_nameString

The name of the virtual router in which to create the route. If the virtual router is in a shared mesh, then you must be the owner of the virtual router resource.

Returns:

  • (String)


438
439
440
441
442
443
444
445
446
447
448
# File 'lib/aws-sdk-appmesh/types.rb', line 438

class CreateRouteInput < Struct.new(
  :client_token,
  :mesh_name,
  :mesh_owner,
  :route_name,
  :spec,
  :tags,
  :virtual_router_name)
  SENSITIVE = []
  include Aws::Structure
end