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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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.

Returned by:

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)

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

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.

#stageString

The name of the associated stage.

Returns:

  • (String)

    The name of the associated stage.