Resource: awsApigatewayv2ApiMapping

Manages an Amazon API Gateway Version 2 API mapping. More information can be found in the Amazon API Gateway Developer Guide.

Example Usage

Basic

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.apigatewayv2ApiMapping.Apigatewayv2ApiMapping(this, "example", {
  apiId: "${aws_apigatewayv2_api.example.id}",
  domainName: "${aws_apigatewayv2_domain_name.example.id}",
  stage: "${aws_apigatewayv2_stage.example.id}",
});

Argument Reference

The following arguments are supported:

• apiId - (Required) API identifier.
• domainName - (Required) Domain name. Use the awsApigatewayv2DomainName resource to configure a domain name.
• stage - (Required) API stage. Use the awsApigatewayv2Stage resource to configure an API stage.
• apiMappingKey - (Optional) The API mapping key.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - API mapping identifier.

Import

awsApigatewayv2ApiMapping can be imported by using the API mapping identifier and domain name, e.g.,

$ terraform import aws_apigatewayv2_api_mapping.example 1122334/ws-api.example.com