You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::AppMesh::Types::CreateVirtualRouterInput

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

Overview

Note:

When making an API call, you may pass CreateVirtualRouterInput data as a hash:

{
  client_token: "String",
  mesh_name: "ResourceName", # required
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "grpc", # required, accepts grpc, http, http2, tcp
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  virtual_router_name: "ResourceName", # required
}

See Also:

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) 


1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1699

class CreateVirtualRouterInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_router_name)
  include Aws::Structure
end

#mesh_name ⇒ String

The name of the service mesh to create the virtual router in.

Returns:

  • (String) 


1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1699

class CreateVirtualRouterInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_router_name)
  include Aws::Structure
end

#spec ⇒ Types::VirtualRouterSpec

The virtual router specification to apply.

Returns:



1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1699

class CreateVirtualRouterInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_router_name)
  include Aws::Structure
end

#tags ⇒ Array<Types::TagRef>

Optional metadata that you can apply to the virtual router 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:



1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1699

class CreateVirtualRouterInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_router_name)
  include Aws::Structure
end

#virtual_router_name ⇒ String

The name to use for the virtual router.

Returns:

  • (String) 


1699
1700
1701
1702
1703
1704
1705
1706
 
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1699

class CreateVirtualRouterInput < Struct.new(
  :client_token,
  :mesh_name,
  :spec,
  :tags,
  :virtual_router_name)
  include Aws::Structure
end