Class: Aws::APIGateway::Types::CreateBasePathMappingRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateBasePathMappingRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-apigateway/types.rb
Overview
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
-
#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 create.
-
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
-
#stage ⇒ String
The name of the API’s stage that you want to use for this mapping.
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. Leave this blank if you do not want callers to specify a base path name after the domain name.
705 706 707 708 709 710 711 |
# File '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_name ⇒ String
The domain name of the BasePathMapping resource to create.
705 706 707 708 709 710 711 |
# File '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_id ⇒ String
The string identifier of the associated RestApi.
705 706 707 708 709 710 711 |
# File 'lib/aws-sdk-apigateway/types.rb', line 705 class CreateBasePathMappingRequest < Struct.new( :domain_name, :base_path, :rest_api_id, :stage) include Aws::Structure end |
#stage ⇒ String
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.
705 706 707 708 709 710 711 |
# File 'lib/aws-sdk-apigateway/types.rb', line 705 class CreateBasePathMappingRequest < Struct.new( :domain_name, :base_path, :rest_api_id, :stage) include Aws::Structure end |