Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. getApiMapping

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getApiMapping

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGatewayV2::ApiMapping resource contains an API mapping. An API mapping relates a path of your custom domain name to a stage of your API. A custom domain name can have multiple API mappings, but the paths can’t overlap. A custom domain can map only to APIs of the same protocol type. For more information, see CreateApiMapping in the Amazon API Gateway V2 API Reference.

    Using getApiMapping

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getApiMapping(args: GetApiMappingArgs, opts?: InvokeOptions): Promise<GetApiMappingResult>
function getApiMappingOutput(args: GetApiMappingOutputArgs, opts?: InvokeOptions): Output<GetApiMappingResult>
    def get_api_mapping(api_mapping_id: Optional[str] = None,
                    domain_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetApiMappingResult
def get_api_mapping_output(api_mapping_id: Optional[pulumi.Input[str]] = None,
                    domain_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetApiMappingResult]
    func LookupApiMapping(ctx *Context, args *LookupApiMappingArgs, opts ...InvokeOption) (*LookupApiMappingResult, error)
func LookupApiMappingOutput(ctx *Context, args *LookupApiMappingOutputArgs, opts ...InvokeOption) LookupApiMappingResultOutput

    > Note: This function is named LookupApiMapping in the Go SDK.

    public static class GetApiMapping 
{
    public static Task<GetApiMappingResult> InvokeAsync(GetApiMappingArgs args, InvokeOptions? opts = null)
    public static Output<GetApiMappingResult> Invoke(GetApiMappingInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiMappingResult> getApiMapping(GetApiMappingArgs args, InvokeOptions options)
public static Output<GetApiMappingResult> getApiMapping(GetApiMappingArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:apigatewayv2:getApiMapping
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiMappingId string
    The API mapping resource ID.
    DomainName string
    The domain name.
    ApiMappingId string
    The API mapping resource ID.
    DomainName string
    The domain name.
    apiMappingId String
    The API mapping resource ID.
    domainName String
    The domain name.
    apiMappingId string
    The API mapping resource ID.
    domainName string
    The domain name.
    api_mapping_id str
    The API mapping resource ID.
    domain_name str
    The domain name.
    apiMappingId String
    The API mapping resource ID.
    domainName String
    The domain name.

    getApiMapping Result

    The following output properties are available:

    ApiId string
    The identifier of the API.
    ApiMappingId string
    The API mapping resource ID.
    ApiMappingKey string
    The API mapping key.
    Stage string
    The API stage.
    ApiId string
    The identifier of the API.
    ApiMappingId string
    The API mapping resource ID.
    ApiMappingKey string
    The API mapping key.
    Stage string
    The API stage.
    apiId String
    The identifier of the API.
    apiMappingId String
    The API mapping resource ID.
    apiMappingKey String
    The API mapping key.
    stage String
    The API stage.
    apiId string
    The identifier of the API.
    apiMappingId string
    The API mapping resource ID.
    apiMappingKey string
    The API mapping key.
    stage string
    The API stage.
    api_id str
    The identifier of the API.
    api_mapping_id str
    The API mapping resource ID.
    api_mapping_key str
    The API mapping key.
    stage str
    The API stage.
    apiId String
    The identifier of the API.
    apiMappingId String
    The API mapping resource ID.
    apiMappingKey String
    The API mapping key.
    stage String
    The API stage.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native