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

Class: Aws::APIGateway::Types::GetBasePathMappingRequest

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

Overview

Note:

When passing GetBasePathMappingRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain_name: "String", # required
  base_path: "String", # required
}

Request to describe a BasePathMapping resource.

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. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name 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.

#domain_nameString

The domain name of the BasePathMapping resource to be described.

Returns:

  • (String)

    The domain name of the BasePathMapping resource to be described.