BasePathMappingArgs class
The set of arguments for BasePathMapping. The set of arguments for BasePathMapping.
Constructors
-
BasePathMappingArgs({Input<
String?> ? basePath, required Input<String> domainName, Input<String?> ? domainNameId, Input<String?> ? region, required Input restApi, Input<String?> ? stageName}) -
Creates a new BasePathMappingArgs.
basePathPath segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.domainNameAlready-registered domain name to connect the API to.domainNameIdIdentifier for the domain name resource. Supported only for private custom domain names.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.restApiID of the API to connect.stageNameName of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.const -
BasePathMappingArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
basePath
→ Input<
String?> ? -
Path segment that must be prepended to the path when accessing the API via this mapping. If omitted, the API is exposed at the root of the given domain.
final
-
domainName
→ Input<
String> -
Already-registered domain name to connect the API to.
final
-
domainNameId
→ Input<
String?> ? -
Identifier for the domain name resource. Supported only for private custom domain names.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- restApi → Input
-
ID of the API to connect.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stageName
→ Input<
String?> ? -
Name of a specific deployment stage to expose at the given path. If omitted, callers may select any stage by including its name as a path element after the base path.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited