class Amazonite::ApiGateway::CreateBasePathMappingRequest

Overview

Requests API Gateway to create a new BasePathMapping resource.

Included Modules

Defined in:

api_gateway/create_base_path_mapping_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(domain_name : String, rest_api_id : String, domain_name_id : String | Nil = nil, base_path : String | Nil = nil, stage : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def base_path : String | Nil #

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.


[View source]
def base_path=(base_path : String | Nil) #

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.


[View source]
def domain_name : String #

The domain name of the BasePathMapping resource to create.


[View source]
def domain_name=(domain_name : String) #

The domain name of the BasePathMapping resource to create.


[View source]
def domain_name_id : String | Nil #

The identifier for the domain name resource. Required for private custom domain names.


[View source]
def domain_name_id=(domain_name_id : String | Nil) #

The identifier for the domain name resource. Required for private custom domain names.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def stage : String | Nil #

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.


[View source]
def stage=(stage : String | Nil) #

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.


[View source]
def validate! : Nil #

[View source]