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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Request to describe a BasePathMapping resource.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #base_path ⇒ String

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

• #domain_name ⇒ String

  The domain name of the BasePathMapping resource to be described.

• #domain_name_id ⇒ String

  The identifier for the domain name resource.

Instance Attribute Details

#base_path ⇒ String

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 2385

class GetBasePathMappingRequest < Struct.new(
  :domain_name,
  :domain_name_id,
  :base_path)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The domain name of the BasePathMapping resource to be described.

Returns:

• (String)

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

class GetBasePathMappingRequest < Struct.new(
  :domain_name,
  :domain_name_id,
  :base_path)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name_id ⇒ String

The identifier for the domain name resource. Supported only for private custom domain names.

Returns:

• (String)

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

class GetBasePathMappingRequest < Struct.new(
  :domain_name,
  :domain_name_id,
  :base_path)
  SENSITIVE = []
  include Aws::Structure
end