Class: Aws::MigrationHubRefactorSpaces::Types::GetRouteResponse

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

Overview

Constant Summary collapse

SENSITIVE =
[:tags]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The ID of the application that the route belongs to.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#arnString

The Amazon Resource Name (ARN) of the route.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#created_by_account_idString

The Amazon Web Services account ID of the route creator.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#created_timeTime

The timestamp of when the route is created.

Returns:

  • (Time)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#environment_idString

Unique identifier of the environment.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#errorTypes::ErrorResponse

Any error associated with the route resource.



1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#include_child_pathsBoolean

Indicates whether to match all subpaths of the given source path. If this value is false, requests must match the source path exactly before they are forwarded to this route's service.

Returns:

  • (Boolean)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#last_updated_timeTime

A timestamp that indicates when the route was last updated.

Returns:

  • (Time)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#methodsArray<String>

A list of HTTP methods to match. An empty list matches all values. If a method is present, only HTTP requests using that method are forwarded to this route’s service.

Returns:

  • (Array<String>)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#owner_account_idString

The Amazon Web Services account ID of the route owner.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#path_resource_to_idHash<String,String>

A mapping of Amazon API Gateway path resources to resource IDs.

Returns:

  • (Hash<String,String>)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#route_idString

The unique identifier of the route.

DEFAULT: All traffic that does not match another route is forwarded to the default route. Applications must have a default route before any other routes can be created.

URI_PATH: A route that is based on a URI path.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#route_typeString

The type of route.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#service_idString

The unique identifier of the service.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#source_pathString

The path to use to match traffic. Paths must start with / and are relative to the base of the application.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#stateString

The current state of the route.

Returns:

  • (String)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end

#tagsHash<String,String>

The tags assigned to the route. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key-value pair.

Returns:

  • (Hash<String,String>)


1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'gems/aws-sdk-migrationhubrefactorspaces/lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1658

class GetRouteResponse < Struct.new(
  :application_id,
  :arn,
  :created_by_account_id,
  :created_time,
  :environment_id,
  :error,
  :include_child_paths,
  :last_updated_time,
  :methods,
  :owner_account_id,
  :path_resource_to_id,
  :route_id,
  :route_type,
  :service_id,
  :source_path,
  :state,
  :tags)
  SENSITIVE = [:tags]
  include Aws::Structure
end