class
Amazonite::ApiGateway::CreateBasePathMappingRequest
- Amazonite::ApiGateway::CreateBasePathMappingRequest
- Reference
- Object
Overview
Requests API Gateway to create a new BasePathMapping resource.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/create_base_path_mapping_request.crConstructors
- .new(domain_name : String, rest_api_id : String, domain_name_id : String | Nil = nil, base_path : String | Nil = nil, stage : String | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#base_path : String | Nil
The base path name that callers of the API must provide as part of the URL after the domain name.
-
#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.
-
#domain_name : String
The domain name of the BasePathMapping resource to create.
-
#domain_name=(domain_name : String)
The domain name of the BasePathMapping resource to create.
-
#domain_name_id : String | Nil
The identifier for the domain name resource.
-
#domain_name_id=(domain_name_id : String | Nil)
The identifier for the domain name resource.
-
#hash(hasher)
See
Object#hash(hasher) -
#rest_api_id : String
The string identifier of the associated RestApi.
-
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
-
#stage : String | Nil
The name of the API's stage that you want to use for this mapping.
-
#stage=(stage : String | Nil)
The name of the API's stage that you want to use for this mapping.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
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.
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.
The identifier for the domain name resource. Required for private custom domain names.
The identifier for the domain name resource. Required for private custom domain names.
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.
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.