Class: Aws::AppMesh::Types::ListGatewayRoutesInput

Inherits:

Struct

• Object
• Struct
• Aws::AppMesh::Types::ListGatewayRoutesInput

Defined in:

gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb

Overview

Note:

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

{
  limit: 1,
  mesh_name: "ResourceName", # required
  mesh_owner: "AccountId",
  next_token: "String",
  virtual_gateway_name: "ResourceName", # required
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #limit ⇒ Integer

  The maximum number of results returned by ListGatewayRoutes in paginated output.

• #mesh_name ⇒ String

  The name of the service mesh to list gateway routes in.

• #mesh_owner ⇒ String

  The AWS IAM account ID of the service mesh owner.

• #next_token ⇒ String

  The nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter.

• #virtual_gateway_name ⇒ String

  The name of the virtual gateway to list gateway routes in.

Instance Attribute Details

#limit ⇒ Integer

The maximum number of results returned by ListGatewayRoutes in paginated output. When you use this parameter, ListGatewayRoutes returns only limit results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListGatewayRoutes request with the returned nextToken value. This value can be between 1 and 100. If you don't use this parameter, ListGatewayRoutes returns up to 100 results and a nextToken value if applicable.

Returns:

• (Integer)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4582

class ListGatewayRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_name ⇒ String

The name of the service mesh to list gateway routes in.

Returns:

• (String)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4582

class ListGatewayRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#mesh_owner ⇒ String

The AWS 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.

Returns:

• (String)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4582

class ListGatewayRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ String

The nextToken value returned from a previous paginated ListGatewayRoutes request where limit was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

Returns:

• (String)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4582

class ListGatewayRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end

#virtual_gateway_name ⇒ String

The name of the virtual gateway to list gateway routes in.

Returns:

• (String)

# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 4582

class ListGatewayRoutesInput < Struct.new(
  :limit,
  :mesh_name,
  :mesh_owner,
  :next_token,
  :virtual_gateway_name)
  SENSITIVE = []
  include Aws::Structure
end