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
  mesh_owner: "AccountId",
  spec: { # required
    listeners: [
      {
        port_mapping: { # required
          port: 1, # required
          protocol: "http", # required, accepts http, tcp, http2, grpc
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  virtual_router_name: "ResourceName", # required
}

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)


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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

#mesh_nameString

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

Returns:

  • (String)


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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

#mesh_ownerString

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.

Returns:

  • (String)


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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

#specTypes::VirtualRouterSpec

The virtual router specification to apply.



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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

#tagsArray<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:



1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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

#virtual_router_nameString

The name to use for the virtual router.

Returns:

  • (String)


1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 1553

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