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

Package-level declarations

Types

class Api : KotlinCustomResource

Manages an Amazon API Gateway Version 2 API.

data class ApiArgs(val apiKeySelectionExpression: Output<String>? = null, val body: Output<String>? = null, val corsConfiguration: Output<ApiCorsConfigurationArgs>? = null, val credentialsArn: Output<String>? = null, val description: Output<String>? = null, val disableExecuteApiEndpoint: 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>

Manages an Amazon API Gateway Version 2 API.

ApiArgsBuilder

class ApiArgsBuilder

Builder for ApiArgs.

Apigatewayv2Functions

object Apigatewayv2Functions

ApiMapper

object ApiMapper : ResourceMapper<Api>

ApiMapping

class ApiMapping : KotlinCustomResource

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

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>

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

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

Manages an Amazon API Gateway Version 2 authorizer. More information can be found in the Amazon 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 identitySources: Output<List<String>>? = null, val jwtConfiguration: Output<AuthorizerJwtConfigurationArgs>? = null, val name: Output<String>? = null) : ConvertibleToJava<AuthorizerArgs>

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

AuthorizerArgsBuilder

class AuthorizerArgsBuilder

Builder for AuthorizerArgs.

AuthorizerMapper

object AuthorizerMapper : ResourceMapper<Authorizer>

AuthorizerResourceBuilder

class AuthorizerResourceBuilder

Builder for Authorizer.

Deployment

class Deployment : KotlinCustomResource

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

DeploymentArgs

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

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

DeploymentArgsBuilder

class DeploymentArgsBuilder

Builder for DeploymentArgs.

DeploymentMapper

object DeploymentMapper : ResourceMapper<Deployment>

DeploymentResourceBuilder

class DeploymentResourceBuilder

Builder for Deployment.

DomainName

class DomainName : KotlinCustomResource

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

DomainNameArgs

data class DomainNameArgs(val domainName: Output<String>? = null, val domainNameConfiguration: Output<DomainNameDomainNameConfigurationArgs>? = null, val mutualTlsAuthentication: Output<DomainNameMutualTlsAuthenticationArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DomainNameArgs>

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

DomainNameArgsBuilder

class DomainNameArgsBuilder

Builder for DomainNameArgs.

DomainNameMapper

object DomainNameMapper : ResourceMapper<DomainName>

DomainNameResourceBuilder

class DomainNameResourceBuilder

Builder for DomainName.

Integration

class Integration : KotlinCustomResource

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

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<List<IntegrationResponseParameterArgs>>? = null, val templateSelectionExpression: Output<String>? = null, val timeoutMilliseconds: Output<Int>? = null, val tlsConfig: Output<IntegrationTlsConfigArgs>? = null) : ConvertibleToJava<IntegrationArgs>

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

IntegrationArgsBuilder

class IntegrationArgsBuilder

Builder for IntegrationArgs.

IntegrationMapper

object IntegrationMapper : ResourceMapper<Integration>

IntegrationResourceBuilder

class IntegrationResourceBuilder

Builder for Integration.

IntegrationResponse

class IntegrationResponse : KotlinCustomResource

Manages an Amazon API Gateway Version 2 integration response. More information can be found in the Amazon 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 responseTemplates: Output<Map<String, String>>? = null, val templateSelectionExpression: Output<String>? = null) : ConvertibleToJava<IntegrationResponseArgs>

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

IntegrationResponseArgsBuilder

class IntegrationResponseArgsBuilder

Builder for IntegrationResponseArgs.

IntegrationResponseMapper

object IntegrationResponseMapper : ResourceMapper<IntegrationResponse>

IntegrationResponseResourceBuilder

class IntegrationResponseResourceBuilder

Builder for IntegrationResponse.

Model

class Model : KotlinCustomResource

Manages an Amazon API Gateway Version 2 model.

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<String>? = null) : ConvertibleToJava<ModelArgs>

Manages an Amazon API Gateway Version 2 model.

ModelArgsBuilder

class ModelArgsBuilder

Builder for ModelArgs.

ModelMapper

object ModelMapper : ResourceMapper<Model>

ModelResourceBuilder

class ModelResourceBuilder

Builder for Model.

Route

class Route : KotlinCustomResource

Manages an Amazon API Gateway Version 2 route. More information can be found in the Amazon API Gateway Developer Guide for WebSocket and HTTP APIs.

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<Map<String, String>>? = null, val requestParameters: Output<List<RouteRequestParameterArgs>>? = null, val routeKey: Output<String>? = null, val routeResponseSelectionExpression: Output<String>? = null, val target: Output<String>? = null) : ConvertibleToJava<RouteArgs>

Manages an Amazon API Gateway Version 2 route. More information can be found in the Amazon API Gateway Developer Guide for WebSocket and HTTP APIs.

RouteArgsBuilder

class RouteArgsBuilder

Builder for RouteArgs.

RouteMapper

object RouteMapper : ResourceMapper<Route>

RouteResourceBuilder

class RouteResourceBuilder

Builder for Route.

RouteResponse

class RouteResponse : KotlinCustomResource

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

RouteResponseArgs

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

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

RouteResponseArgsBuilder

class RouteResponseArgsBuilder

Builder for RouteResponseArgs.

RouteResponseMapper

object RouteResponseMapper : ResourceMapper<RouteResponse>

RouteResponseResourceBuilder

class RouteResponseResourceBuilder

Builder for RouteResponse.

Stage

class Stage : KotlinCustomResource

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

StageArgs

data class StageArgs(val accessLogSettings: Output<StageAccessLogSettingsArgs>? = null, val apiId: Output<String>? = null, val autoDeploy: Output<Boolean>? = null, val clientCertificateId: Output<String>? = null, val defaultRouteSettings: Output<StageDefaultRouteSettingsArgs>? = null, val deploymentId: Output<String>? = null, val description: Output<String>? = null, val name: Output<String>? = null, val routeSettings: Output<List<StageRouteSettingArgs>>? = null, val stageVariables: Output<Map<String, String>>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<StageArgs>

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

StageArgsBuilder

class StageArgsBuilder

Builder for StageArgs.

StageMapper

object StageMapper : ResourceMapper<Stage>

StageResourceBuilder

class StageResourceBuilder

Builder for Stage.

VpcLink

class VpcLink : KotlinCustomResource

Manages an Amazon API Gateway Version 2 VPC Link.

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>

Manages an Amazon API Gateway Version 2 VPC Link.

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

stage

fun stage(name: String): Stage

suspend fun stage(name: String, block: suspend StageResourceBuilder.() -> Unit): Stage

vpcLink

fun vpcLink(name: String): VpcLink

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