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

Class: Aws::APIGateway::Types::CreateBasePathMappingRequest

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 CreateBasePathMappingRequest data as a hash:

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

Requests Amazon API Gateway to create a new 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 a base path name after the domain name.

Returns:

  • (String)


705
706
707
708
709
710
711
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 705

class CreateBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end

#domain_nameString

The domain name of the BasePathMapping resource to create.

Returns:

  • (String)


705
706
707
708
709
710
711
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 705

class CreateBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


705
706
707
708
709
710
711
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 705

class CreateBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end

#stageString

The name of the API's stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.

Returns:

  • (String)


705
706
707
708
709
710
711
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 705

class CreateBasePathMappingRequest < Struct.new(
  :domain_name,
  :base_path,
  :rest_api_id,
  :stage)
  include Aws::Structure
end