BasePathMapping class

Connects a custom domain name registered via aws.apigateway.DomainName with a deployed API so that its methods can be called via the custom domain name.

Import

For a non-root basePath:

For a non-root basePath and a private custom domain name:

Using pulumi import, import aws.apigateway.BasePathMapping using the domain name and base path or domain name, base path and domain name ID (for private custom domain names). For example:

For an empty basePath or, in other words, a root path (/):

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/

For a non-root basePath:

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/base-path

For a non-root basePath and a private custom domain name:

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example api.internal.example.com/base-path/abcde12345

Constructors

BasePathMapping(String name, {BasePathMappingArgs? args, CustomResourceOptions? options})
Creates a new BasePathMapping. name The Pulumi resource name. args Arguments used to configure this BasePathMapping. The set of arguments for BasePathMapping. options Resource options controlling this resource's behavior.
BasePathMapping.reference(String urn)
Creates a typed reference to an existing BasePathMapping resource.

Properties

basePath ↔ Output<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.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
domainName ↔ Output<String>
Already-registered domain name to connect the API to.
latefinal
domainNameId ↔ Output<String?>
Identifier for the domain name resource. Supported only for private custom domain names.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
restApi ↔ Output<String>
ID of the API to connect.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stageName ↔ Output<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.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BasePathMappingState? state, CustomResourceOptions? options}) → BasePathMapping
Gets an existing BasePathMapping resource's state with the given name and id.