pulumi-aws-native-kotlin/com.pulumi.awsnative.apigatewayv2.kotlin/Apigatewayv2Functions

Apigatewayv2Functions

object Apigatewayv2Functions

Functions

Link copied to clipboard
suspend fun getApi(argument: GetApiPlainArgs): GetApiResult

The `AWS::ApiGatewayV2::Api` resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide. For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.

suspend fun getApi(apiId: String): GetApiResult
suspend fun getApi(argument: suspend GetApiPlainArgsBuilder.() -> Unit): GetApiResult
Link copied to clipboard
suspend fun getApiMapping(argument: GetApiMappingPlainArgs): GetApiMappingResult

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.

suspend fun getApiMapping(argument: suspend GetApiMappingPlainArgsBuilder.() -> Unit): GetApiMappingResult
suspend fun getApiMapping(apiMappingId: String, domainName: String): GetApiMappingResult
Link copied to clipboard
suspend fun getAuthorizer(argument: GetAuthorizerPlainArgs): GetAuthorizerResult

The `AWS::ApiGatewayV2::Authorizer` resource creates an authorizer for a WebSocket API or an HTTP API. To learn more, see Controlling and managing access to a WebSocket API in API Gateway and Controlling and managing access to an HTTP API in API Gateway in the API Gateway Developer Guide.

suspend fun getAuthorizer(argument: suspend GetAuthorizerPlainArgsBuilder.() -> Unit): GetAuthorizerResult
suspend fun getAuthorizer(apiId: String, authorizerId: String): GetAuthorizerResult
Link copied to clipboard
suspend fun getDeployment(argument: GetDeploymentPlainArgs): GetDeploymentResult

The `AWS::ApiGatewayV2::Deployment` resource creates a deployment for an API.

suspend fun getDeployment(argument: suspend GetDeploymentPlainArgsBuilder.() -> Unit): GetDeploymentResult
suspend fun getDeployment(apiId: String, deploymentId: String): GetDeploymentResult
Link copied to clipboard
suspend fun getDomainName(argument: GetDomainNamePlainArgs): GetDomainNameResult

The `AWS::ApiGatewayV2::DomainName` resource specifies a custom domain name for your API in Amazon API Gateway (API Gateway). You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide.

suspend fun getDomainName(domainName: String): GetDomainNameResult
suspend fun getDomainName(argument: suspend GetDomainNamePlainArgsBuilder.() -> Unit): GetDomainNameResult
Link copied to clipboard
suspend fun getIntegration(argument: GetIntegrationPlainArgs): GetIntegrationResult

An example resource schema demonstrating some basic constructs and validation rules.

suspend fun getIntegration(argument: suspend GetIntegrationPlainArgsBuilder.() -> Unit): GetIntegrationResult
suspend fun getIntegration(apiId: String, integrationId: String): GetIntegrationResult
Link copied to clipboard
suspend fun getIntegrationResponse(argument: GetIntegrationResponsePlainArgs): GetIntegrationResponseResult

The `AWS::ApiGatewayV2::IntegrationResponse` resource updates an integration response for an WebSocket API. For more information, see Set up WebSocket API Integration Responses in API Gateway in the API Gateway Developer Guide.

suspend fun getIntegrationResponse(argument: suspend GetIntegrationResponsePlainArgsBuilder.() -> Unit): GetIntegrationResponseResult
suspend fun getIntegrationResponse(apiId: String, integrationId: String, integrationResponseId: String): GetIntegrationResponseResult
Link copied to clipboard
suspend fun getModel(argument: GetModelPlainArgs): GetModelResult

The `AWS::ApiGatewayV2::Model` resource updates data model for a WebSocket API. For more information, see Model Selection Expressions in the API Gateway Developer Guide.

suspend fun getModel(argument: suspend GetModelPlainArgsBuilder.() -> Unit): GetModelResult
suspend fun getModel(apiId: String, modelId: String): GetModelResult
Link copied to clipboard
suspend fun getRoute(argument: GetRoutePlainArgs): GetRouteResult

The `AWS::ApiGatewayV2::Route` resource creates a route for an API.

suspend fun getRoute(argument: suspend GetRoutePlainArgsBuilder.() -> Unit): GetRouteResult
suspend fun getRoute(apiId: String, routeId: String): GetRouteResult
Link copied to clipboard
suspend fun getRouteResponse(argument: GetRouteResponsePlainArgs): GetRouteResponseResult

The `AWS::ApiGatewayV2::RouteResponse` resource creates a route response for a WebSocket API. For more information, see Set up Route Responses for a WebSocket API in API Gateway in the API Gateway Developer Guide.

suspend fun getRouteResponse(argument: suspend GetRouteResponsePlainArgsBuilder.() -> Unit): GetRouteResponseResult
suspend fun getRouteResponse(apiId: String, routeId: String, routeResponseId: String): GetRouteResponseResult
Link copied to clipboard
suspend fun getVpcLink(argument: GetVpcLinkPlainArgs): GetVpcLinkResult

The `AWS::ApiGatewayV2::VpcLink` resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from `PENDING` to `AVAILABLE` to successfully create a VPC link, which can take up to 10 minutes. To learn more, see Working with VPC Links for HTTP APIs in the API Gateway Developer Guide.

suspend fun getVpcLink(vpcLinkId: String): GetVpcLinkResult
suspend fun getVpcLink(argument: suspend GetVpcLinkPlainArgsBuilder.() -> Unit): GetVpcLinkResult