Class: Aws::APIGateway::Types::BasePathMapping

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Represents the base path that callers of the API must provide as part of the URL after the domain name.

<div class=“remarks”> A custom domain name plus a ‘BasePathMapping` specification identifies a deployed RestApi in a given stage of the owner Account. </div>

<div class=“seeAlso”>

Use Custom Domain Names][1

</div>

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html

Instance Attribute Summary collapse

Instance Attribute Details

#base_path ⇒ String

The base path name that callers of the API must provide as part of the URL after the domain name.

Returns:

  • (String) 


407
408
409
410
411
412
 
# File 'lib/aws-sdk-apigateway/types.rb', line 407

class BasePathMapping < Struct.new(
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

  • (String) 


407
408
409
410
411
412
 
# File 'lib/aws-sdk-apigateway/types.rb', line 407

class BasePathMapping < Struct.new(
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end

#stage ⇒ String

The name of the associated stage.

Returns:

  • (String) 


407
408
409
410
411
412
 
# File 'lib/aws-sdk-apigateway/types.rb', line 407

class BasePathMapping < Struct.new(
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end