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

Inherits:

Struct

• Object
• Struct
• Aws::MigrationHubRefactorSpaces::Types::GetRouteResponse

Includes:

Structure

Defined in:

lib/aws-sdk-migrationhubrefactorspaces/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:tags]

Instance Attribute Summary

• #append_source_path ⇒ Boolean

  If set to ‘true`, this option appends the source path to the service URL endpoint.

• #application_id ⇒ String

  The ID of the application that the route belongs to.

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the route.

• #created_by_account_id ⇒ String

  The Amazon Web Services account ID of the route creator.

• #created_time ⇒ Time

  The timestamp of when the route is created.

• #environment_id ⇒ String

  Unique identifier of the environment.

• #error ⇒ Types::ErrorResponse

  Any error associated with the route resource.

• #include_child_paths ⇒ Boolean

  Indicates whether to match all subpaths of the given source path.

• #last_updated_time ⇒ Time

  A timestamp that indicates when the route was last updated.

• #methods ⇒ Array<String>

  A list of HTTP methods to match.

• #owner_account_id ⇒ String

  The Amazon Web Services account ID of the route owner.

• #path_resource_to_id ⇒ Hash<String,String>

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

• #route_id ⇒ String

  The unique identifier of the route.

• #route_type ⇒ String

  The type of route.

• #service_id ⇒ String

  The unique identifier of the service.

• #source_path ⇒ String

  This is the path that Refactor Spaces uses to match traffic.

• #state ⇒ String

  The current state of the route.

• #tags ⇒ Hash<String,String>

  The tags assigned to the route.

Instance Attribute Details

#append_source_path ⇒ Boolean

If set to ‘true`, this option appends the source path to the service URL endpoint.

Returns:

• (Boolean)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#application_id ⇒ String

The ID of the application that the route belongs to.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#arn ⇒ String

The Amazon Resource Name (ARN) of the route.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ String

The Amazon Web Services account ID of the route creator.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_time ⇒ Time

The timestamp of when the route is created.

Returns:

• (Time)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ String

Unique identifier of the environment.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#error ⇒ Types::ErrorResponse

Any error associated with the route resource.

Returns:

• (Types::ErrorResponse)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_paths ⇒ Boolean

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)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_time ⇒ Time

A timestamp that indicates when the route was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#methods ⇒ Array<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>)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ String

The Amazon Web Services account ID of the route owner.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ String

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)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_type ⇒ String

The type of route.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_id ⇒ String

The unique identifier of the service.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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_path ⇒ String

This is the path that Refactor Spaces uses to match traffic. Paths must start with ‘/` and are relative to the base of the application. To use path parameters in the source path, add a variable in curly braces. For example, the resource path user represents a path parameter called ’user’.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#state ⇒ String

The current state of the route.

Returns:

• (String)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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

#tags ⇒ Hash<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>)

# File 'lib/aws-sdk-migrationhubrefactorspaces/types.rb', line 1516

class GetRouteResponse < Struct.new(
  :append_source_path,
  :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