pulumi-aws-kotlin/com.pulumi.aws.apigateway.kotlin/BasePathMappingArgs

BasePathMappingArgs

data class BasePathMappingArgs(val basePath: Output<String>? = null, val domainName: Output<String>? = null, val domainNameId: Output<String>? = null, val restApi: Output<String>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<BasePathMappingArgs>

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 base_path: For a non-root base_path and a private custom domain name: Using pulumi import, import aws_api_gateway_base_path_mapping 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 base_path or, in other words, a root path (/):

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/
Content copied to clipboard

For a non-root base_path:

$ pulumi import aws:apigateway/basePathMapping:BasePathMapping example example.com/base-path
Content copied to clipboard

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

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

Constructors

Link copied to clipboard
constructor(basePath: Output<String>? = null, domainName: Output<String>? = null, domainNameId: Output<String>? = null, restApi: Output<String>? = null, stageName: Output<String>? = null)

Properties

Link copied to clipboard
val basePath: Output<String>? = null

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.

Link copied to clipboard
val domainName: Output<String>? = null

Already-registered domain name to connect the API to.

Link copied to clipboard
val domainNameId: Output<String>? = null

The identifier for the domain name resource. Supported only for private custom domain names.

Link copied to clipboard
val restApi: Output<String>? = null

ID of the API to connect.

Link copied to clipboard
val stageName: Output<String>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): BasePathMappingArgs