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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateBasePathMappingRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

• #domain_name_id ⇒ String

  The identifier for the domain name resource.

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

Returns:

• (String)

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

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

#domain_name ⇒ String

The domain name of the BasePathMapping resource to create.

Returns:

• (String)

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

class CreateBasePathMappingRequest < Struct.new(
  :domain_name,
  :domain_name_id,
  :base_path,
  :rest_api_id,
  :stage)
  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 656

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

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

• (String)

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

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

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

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

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