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 API Gateway to create a new BasePathMapping resource.

Constant Summary collapse

SENSITIVE =
[]

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. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

Returns:

  • (String)


852
853
854
855
856
857
858
859
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 852

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

#domain_nameString

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

Returns:

  • (String)


852
853
854
855
856
857
858
859
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 852

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

#rest_api_idString

[Required] The string identifier of the associated RestApi.

Returns:

  • (String)


852
853
854
855
856
857
858
859
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 852

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

#stageString

The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

Returns:

  • (String)


852
853
854
855
856
857
858
859
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 852

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