1. Packages
  2. AWS Native
  3. API Docs
  4. apigateway
  5. getBasePathMapping

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.apigateway.getBasePathMapping

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    The AWS::ApiGateway::BasePathMapping resource creates a base path that clients who call your API must use in the invocation URL.

    Using getBasePathMapping

    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 getBasePathMapping(args: GetBasePathMappingArgs, opts?: InvokeOptions): Promise<GetBasePathMappingResult>
    function getBasePathMappingOutput(args: GetBasePathMappingOutputArgs, opts?: InvokeOptions): Output<GetBasePathMappingResult>
    def get_base_path_mapping(base_path: Optional[str] = None,
                              domain_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetBasePathMappingResult
    def get_base_path_mapping_output(base_path: Optional[pulumi.Input[str]] = None,
                              domain_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetBasePathMappingResult]
    func LookupBasePathMapping(ctx *Context, args *LookupBasePathMappingArgs, opts ...InvokeOption) (*LookupBasePathMappingResult, error)
    func LookupBasePathMappingOutput(ctx *Context, args *LookupBasePathMappingOutputArgs, opts ...InvokeOption) LookupBasePathMappingResultOutput

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

    public static class GetBasePathMapping 
    {
        public static Task<GetBasePathMappingResult> InvokeAsync(GetBasePathMappingArgs args, InvokeOptions? opts = null)
        public static Output<GetBasePathMappingResult> Invoke(GetBasePathMappingInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetBasePathMappingResult> getBasePathMapping(GetBasePathMappingArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:apigateway:getBasePathMapping
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BasePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    DomainName string
    The domain name of the BasePathMapping resource to be described.
    BasePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    DomainName string
    The domain name of the BasePathMapping resource to be described.
    basePath String
    The base path name that callers of the API must provide as part of the URL after the domain name.
    domainName String
    The domain name of the BasePathMapping resource to be described.
    basePath string
    The base path name that callers of the API must provide as part of the URL after the domain name.
    domainName string
    The domain name of the BasePathMapping resource to be described.
    base_path str
    The base path name that callers of the API must provide as part of the URL after the domain name.
    domain_name str
    The domain name of the BasePathMapping resource to be described.
    basePath String
    The base path name that callers of the API must provide as part of the URL after the domain name.
    domainName String
    The domain name of the BasePathMapping resource to be described.

    getBasePathMapping Result

    The following output properties are available:

    RestApiId string
    The string identifier of the associated RestApi.
    Stage string
    The name of the associated stage.
    RestApiId string
    The string identifier of the associated RestApi.
    Stage string
    The name of the associated stage.
    restApiId String
    The string identifier of the associated RestApi.
    stage String
    The name of the associated stage.
    restApiId string
    The string identifier of the associated RestApi.
    stage string
    The name of the associated stage.
    rest_api_id str
    The string identifier of the associated RestApi.
    stage str
    The name of the associated stage.
    restApiId String
    The string identifier of the associated RestApi.
    stage String
    The name of the associated stage.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi