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

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

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


2521
2522
2523
2524
2525
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2521

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

#domain_nameString

The domain name of the BasePathMapping resource to be described.

Returns:

  • (String)


2521
2522
2523
2524
2525
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2521

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