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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateBasePathMappingRequest as input to an Aws::Client method, you can use a vanilla Hash:

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

Requests API Gateway to create a new BasePathMapping resource.

Instance Attribute Summary collapse

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 a base path name after the domain name.

Returns:

  • (String) —

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

#domain_name ⇒ String

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

Returns:

  • (String) —

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

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.

#stage ⇒ String

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) —

    The name of the API\'s stage that you want to use for this mapping.