You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

A custom domain name plus a `BasePathMapping` specification identifies a deployed RestApi in a given stage of the owner Account.
[Use Custom Domain Names][1]

Instance Attribute Summary collapse

Instance Attribute Details

#base_pathString

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 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 407

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


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

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

#stageString

The name of the associated stage.

Returns:

  • (String)


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

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