Explore with Pulumi AI
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
@overload def ApiMapping(resource_name: str, opts: Optional[ResourceOptions] = None, api_id: Optional[str] = None, api_mapping_key: Optional[str] = None, domain_name: Optional[str] = None, stage: Optional[str] = None) @overload def ApiMapping(resource_name: str, args: ApiMappingArgs, opts: Optional[ResourceOptions] = None)
type: aws-native:apigatewayv2:ApiMapping properties: # The arguments to resource properties. options: # Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiMappingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
ApiMapping Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
The ApiMapping resource accepts the following input properties:
All input properties are implicitly available as output properties. Additionally, the ApiMapping resource produces the following output properties:
- AWS Native pulumi/pulumi-aws-native