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

Package-level declarations

Types

class Api : KotlinCustomResource

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.

ApiArgs

data class ApiArgs(val apiKeySelectionExpression: Output<String>? = null, val basePath: Output<String>? = null, val body: Output<Any>? = null, val bodyS3Location: Output<ApiBodyS3LocationArgs>? = null, val corsConfiguration: Output<ApiCorsArgs>? = null, val credentialsArn: Output<String>? = null, val description: Output<String>? = null, val disableExecuteApiEndpoint: Output<Boolean>? = null, val disableSchemaValidation: Output<Boolean>? = null, val failOnWarnings: Output<Boolean>? = null, val ipAddressType: Output<String>? = null, val name: Output<String>? = null, val protocolType: Output<String>? = null, val routeKey: Output<String>? = null, val routeSelectionExpression: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val target: Output<String>? = null, val version: Output<String>? = null) : ConvertibleToJava<ApiArgs>

ApiArgsBuilder

class ApiArgsBuilder

Builder for ApiArgs.

Apigatewayv2Functions

object Apigatewayv2Functions

ApiMapper

object ApiMapper : ResourceMapper<Api>

ApiMapping

class ApiMapping : KotlinCustomResource

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.

ApiMappingArgs

data class ApiMappingArgs(val apiId: Output<String>? = null, val apiMappingKey: Output<String>? = null, val domainName: Output<String>? = null, val stage: Output<String>? = null) : ConvertibleToJava<ApiMappingArgs>

ApiMappingArgsBuilder

class ApiMappingArgsBuilder

Builder for ApiMappingArgs.

ApiMappingMapper

object ApiMappingMapper : ResourceMapper<ApiMapping>

ApiMappingResourceBuilder

class ApiMappingResourceBuilder

Builder for ApiMapping.

ApiResourceBuilder

class ApiResourceBuilder

Builder for Api.

Authorizer

class Authorizer : KotlinCustomResource

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.

AuthorizerArgs

data class AuthorizerArgs(val apiId: Output<String>? = null, val authorizerCredentialsArn: Output<String>? = null, val authorizerPayloadFormatVersion: Output<String>? = null, val authorizerResultTtlInSeconds: Output<Int>? = null, val authorizerType: Output<String>? = null, val authorizerUri: Output<String>? = null, val enableSimpleResponses: Output<Boolean>? = null, val identitySource: Output<List<String>>? = null, val identityValidationExpression: Output<String>? = null, val jwtConfiguration: Output<AuthorizerJwtConfigurationArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<AuthorizerArgs>

AuthorizerArgsBuilder

class AuthorizerArgsBuilder

Builder for AuthorizerArgs.

AuthorizerMapper

object AuthorizerMapper : ResourceMapper<Authorizer>

AuthorizerResourceBuilder

class AuthorizerResourceBuilder

Builder for Authorizer.

Deployment

class Deployment : KotlinCustomResource

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

DeploymentArgs

data class DeploymentArgs(val apiId: Output<String>? = null, val description: Output<String>? = null, val stageName: Output<String>? = null) : ConvertibleToJava<DeploymentArgs>

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

DeploymentArgsBuilder

class DeploymentArgsBuilder

Builder for DeploymentArgs.

DeploymentMapper

object DeploymentMapper : ResourceMapper<Deployment>

DeploymentResourceBuilder

class DeploymentResourceBuilder

Builder for Deployment.

DomainName

class DomainName : KotlinCustomResource

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.

DomainNameArgs

data class DomainNameArgs(val domainName: Output<String>? = null, val domainNameConfigurations: Output<List<DomainNameConfigurationArgs>>? = null, val mutualTlsAuthentication: Output<DomainNameMutualTlsAuthenticationArgs>? = null, val routingMode: Output<DomainNameRoutingMode>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DomainNameArgs>

DomainNameArgsBuilder

class DomainNameArgsBuilder

Builder for DomainNameArgs.

DomainNameMapper

object DomainNameMapper : ResourceMapper<DomainName>

DomainNameResourceBuilder

class DomainNameResourceBuilder

Builder for DomainName.

Integration

class Integration : KotlinCustomResource

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

IntegrationArgs

data class IntegrationArgs(val apiId: Output<String>? = null, val connectionId: Output<String>? = null, val connectionType: Output<String>? = null, val contentHandlingStrategy: Output<String>? = null, val credentialsArn: Output<String>? = null, val description: Output<String>? = null, val integrationMethod: Output<String>? = null, val integrationSubtype: Output<String>? = null, val integrationType: Output<String>? = null, val integrationUri: Output<String>? = null, val passthroughBehavior: Output<String>? = null, val payloadFormatVersion: Output<String>? = null, val requestParameters: Output<Map<String, String>>? = null, val requestTemplates: Output<Map<String, String>>? = null, val responseParameters: Output<Map<String, IntegrationResponseParameterMapArgs>>? = null, val templateSelectionExpression: Output<String>? = null, val timeoutInMillis: Output<Int>? = null, val tlsConfig: Output<IntegrationTlsConfigArgs>? = null) : ConvertibleToJava<IntegrationArgs>

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

IntegrationArgsBuilder

class IntegrationArgsBuilder

Builder for IntegrationArgs.

IntegrationMapper

object IntegrationMapper : ResourceMapper<Integration>

IntegrationResourceBuilder

class IntegrationResourceBuilder

Builder for Integration.

IntegrationResponse

class IntegrationResponse : KotlinCustomResource

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.

IntegrationResponseArgs

data class IntegrationResponseArgs(val apiId: Output<String>? = null, val contentHandlingStrategy: Output<String>? = null, val integrationId: Output<String>? = null, val integrationResponseKey: Output<String>? = null, val responseParameters: Output<Any>? = null, val responseTemplates: Output<Any>? = null, val templateSelectionExpression: Output<String>? = null) : ConvertibleToJava<IntegrationResponseArgs>

IntegrationResponseArgsBuilder

class IntegrationResponseArgsBuilder

Builder for IntegrationResponseArgs.

IntegrationResponseMapper

object IntegrationResponseMapper : ResourceMapper<IntegrationResponse>

IntegrationResponseResourceBuilder

class IntegrationResponseResourceBuilder

Builder for IntegrationResponse.

Model

class Model : KotlinCustomResource

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.

ModelArgs

data class ModelArgs(val apiId: Output<String>? = null, val contentType: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val schema: Output<Any>? = null) : ConvertibleToJava<ModelArgs>

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.

ModelArgsBuilder

class ModelArgsBuilder

Builder for ModelArgs.

ModelMapper

object ModelMapper : ResourceMapper<Model>

ModelResourceBuilder

class ModelResourceBuilder

Builder for Model.

Route

class Route : KotlinCustomResource

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

RouteArgs

data class RouteArgs(val apiId: Output<String>? = null, val apiKeyRequired: Output<Boolean>? = null, val authorizationScopes: Output<List<String>>? = null, val authorizationType: Output<String>? = null, val authorizerId: Output<String>? = null, val modelSelectionExpression: Output<String>? = null, val operationName: Output<String>? = null, val requestModels: Output<Any>? = null, val requestParameters: Output<List<RouteParameterConstraintsArgs>>? = null, val routeKey: Output<String>? = null, val routeResponseSelectionExpression: Output<String>? = null, val target: Output<String>? = null) : ConvertibleToJava<RouteArgs>

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

RouteArgsBuilder

class RouteArgsBuilder

Builder for RouteArgs.

RouteMapper

object RouteMapper : ResourceMapper<Route>

RouteResourceBuilder

class RouteResourceBuilder

Builder for Route.

RouteResponse

class RouteResponse : KotlinCustomResource

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.

RouteResponseArgs

data class RouteResponseArgs(val apiId: Output<String>? = null, val modelSelectionExpression: Output<String>? = null, val responseModels: Output<Any>? = null, val responseParameters: Output<Map<String, RouteResponseParameterConstraintsArgs>>? = null, val routeId: Output<String>? = null, val routeResponseKey: Output<String>? = null) : ConvertibleToJava<RouteResponseArgs>

RouteResponseArgsBuilder

class RouteResponseArgsBuilder

Builder for RouteResponseArgs.

RouteResponseMapper

object RouteResponseMapper : ResourceMapper<RouteResponse>

RouteResponseResourceBuilder

class RouteResponseResourceBuilder

Builder for RouteResponse.

RoutingRule

class RoutingRule : KotlinCustomResource

Schema for AWS::ApiGatewayV2::RoutingRule

RoutingRuleArgs

data class RoutingRuleArgs(val actions: Output<List<RoutingRuleActionArgs>>? = null, val conditions: Output<List<RoutingRuleConditionArgs>>? = null, val domainNameArn: Output<String>? = null, val priority: Output<Int>? = null) : ConvertibleToJava<RoutingRuleArgs>

Schema for AWS::ApiGatewayV2::RoutingRule

RoutingRuleArgsBuilder

class RoutingRuleArgsBuilder

Builder for RoutingRuleArgs.

RoutingRuleMapper

object RoutingRuleMapper : ResourceMapper<RoutingRule>

RoutingRuleResourceBuilder

class RoutingRuleResourceBuilder

Builder for RoutingRule.

VpcLink

class VpcLink : KotlinCustomResource

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.

VpcLinkArgs

data class VpcLinkArgs(val name: Output<String>? = null, val securityGroupIds: Output<List<String>>? = null, val subnetIds: Output<List<String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<VpcLinkArgs>

VpcLinkArgsBuilder

class VpcLinkArgsBuilder

Builder for VpcLinkArgs.

VpcLinkMapper

object VpcLinkMapper : ResourceMapper<VpcLink>

VpcLinkResourceBuilder

class VpcLinkResourceBuilder

Builder for VpcLink.

Functions

api

fun api(name: String): Api

suspend fun api(name: String, block: suspend ApiResourceBuilder.() -> Unit): Api

apiMapping

fun apiMapping(name: String): ApiMapping

suspend fun apiMapping(name: String, block: suspend ApiMappingResourceBuilder.() -> Unit): ApiMapping

authorizer

fun authorizer(name: String): Authorizer

suspend fun authorizer(name: String, block: suspend AuthorizerResourceBuilder.() -> Unit): Authorizer

deployment

fun deployment(name: String): Deployment

suspend fun deployment(name: String, block: suspend DeploymentResourceBuilder.() -> Unit): Deployment

domainName

fun domainName(name: String): DomainName

suspend fun domainName(name: String, block: suspend DomainNameResourceBuilder.() -> Unit): DomainName

integration

fun integration(name: String): Integration

suspend fun integration(name: String, block: suspend IntegrationResourceBuilder.() -> Unit): Integration

integrationResponse

fun integrationResponse(name: String): IntegrationResponse

suspend fun integrationResponse(name: String, block: suspend IntegrationResponseResourceBuilder.() -> Unit): IntegrationResponse

model

fun model(name: String): Model

suspend fun model(name: String, block: suspend ModelResourceBuilder.() -> Unit): Model

route

fun route(name: String): Route

suspend fun route(name: String, block: suspend RouteResourceBuilder.() -> Unit): Route

routeResponse

fun routeResponse(name: String): RouteResponse

suspend fun routeResponse(name: String, block: suspend RouteResponseResourceBuilder.() -> Unit): RouteResponse

routingRule

fun routingRule(name: String): RoutingRule

suspend fun routingRule(name: String, block: suspend RoutingRuleResourceBuilder.() -> Unit): RoutingRule

vpcLink

fun vpcLink(name: String): VpcLink

suspend fun vpcLink(name: String, block: suspend VpcLinkResourceBuilder.() -> Unit): VpcLink