aws-native.apigatewayv2.ApiMapping

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.

Create ApiMapping Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ApiMapping(name: string, args: ApiMappingArgs, opts?: CustomResourceOptions);

@overload
def ApiMapping(resource_name: str,
               args: ApiMappingArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def ApiMapping(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               api_id: Optional[str] = None,
               domain_name: Optional[str] = None,
               stage: Optional[str] = None,
               api_mapping_key: Optional[str] = None)

func NewApiMapping(ctx *Context, name string, args ApiMappingArgs, opts ...ResourceOption) (*ApiMapping, error)

public ApiMapping(string name, ApiMappingArgs args, CustomResourceOptions? opts = null)

public ApiMapping(String name, ApiMappingArgs args)
public ApiMapping(String name, ApiMappingArgs args, CustomResourceOptions options)

type: aws-native:apigatewayv2:ApiMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

ApiMapping Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ApiMapping resource accepts the following input properties:

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiMapping resource produces the following output properties:

Package Details

Repository

AWS Native pulumi/pulumi-aws-native

License

Apache-2.0