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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetBasePathMappingRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetBasePathMappingRequest data as a hash:

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

Request to describe a BasePathMapping resource.

Instance Attribute Summary

• #base_path ⇒ String

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

• #domain_name ⇒ String

  [Required] The domain name of the BasePathMapping resource to be described.

Instance Attribute Details

#base_path ⇒ String

[Required] 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. Specify ‘(none)’ if you do not want callers to specify any base path name after the domain name.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3070

class GetBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path)
  include Aws::Structure
end

#domain_name ⇒ String

[Required] The domain name of the BasePathMapping resource to be described.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3070

class GetBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path)
  include Aws::Structure
end