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

Package-level declarations

Types

data class ApiBodyS3Location(val bucket: String? = null, val etag: String? = null, val key: String? = null, val version: String? = null)

The `BodyS3Location` property specifies an S3 location from which to import an OpenAPI definition. Supported only for HTTP APIs.

ApiCors

data class ApiCors(val allowCredentials: Boolean? = null, val allowHeaders: List<String>? = null, val allowMethods: List<String>? = null, val allowOrigins: List<String>? = null, val exposeHeaders: List<String>? = null, val maxAge: Int? = null)

The `Cors` property specifies a CORS configuration for an API. Supported only for HTTP APIs. See Configuring CORS for more information.

AuthorizerJwtConfiguration

data class AuthorizerJwtConfiguration(val audience: List<String>? = null, val issuer: String? = null)

The `JWTConfiguration` property specifies the configuration of a JWT authorizer. Required for the `JWT` authorizer type. Supported only for HTTP APIs.

DomainNameConfiguration

data class DomainNameConfiguration(val certificateArn: String? = null, val certificateName: String? = null, val endpointType: String? = null, val ipAddressType: String? = null, val ownershipVerificationCertificateArn: String? = null, val securityPolicy: String? = null)

The `DomainNameConfiguration` property type specifies the configuration for an API's domain name. `DomainNameConfiguration` is a property of the AWS::ApiGatewayV2::DomainName resource.

DomainNameMutualTlsAuthentication

data class DomainNameMutualTlsAuthentication(val truststoreUri: String? = null, val truststoreVersion: String? = null)

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

GetApiMappingResult

data class GetApiMappingResult(val apiId: String? = null, val apiMappingId: String? = null, val apiMappingKey: String? = null, val stage: String? = null)

GetApiResult

data class GetApiResult(val apiEndpoint: String? = null, val apiId: String? = null, val apiKeySelectionExpression: String? = null, val corsConfiguration: ApiCors? = null, val description: String? = null, val disableExecuteApiEndpoint: Boolean? = null, val ipAddressType: String? = null, val name: String? = null, val routeSelectionExpression: String? = null, val tags: Map<String, String>? = null, val version: String? = null)

GetAuthorizerResult

data class GetAuthorizerResult(val authorizerId: String? = null, val authorizerType: String? = null, val identitySource: List<String>? = null, val identityValidationExpression: String? = null, val jwtConfiguration: AuthorizerJwtConfiguration? = null, val name: String? = null)

GetDeploymentResult

data class GetDeploymentResult(val deploymentId: String? = null, val description: String? = null)

GetDomainNameResult

data class GetDomainNameResult(val domainNameArn: String? = null, val domainNameConfigurations: List<DomainNameConfiguration>? = null, val mutualTlsAuthentication: DomainNameMutualTlsAuthentication? = null, val regionalDomainName: String? = null, val regionalHostedZoneId: String? = null, val routingMode: DomainNameRoutingMode? = null, val tags: Map<String, String>? = null)

GetIntegrationResponseResult

data class GetIntegrationResponseResult(val contentHandlingStrategy: String? = null, val integrationResponseId: String? = null, val integrationResponseKey: String? = null, val responseParameters: Any? = null, val responseTemplates: Any? = null, val templateSelectionExpression: String? = null)

GetIntegrationResult

data class GetIntegrationResult(val connectionId: String? = null, val connectionType: String? = null, val contentHandlingStrategy: String? = null, val credentialsArn: String? = null, val description: String? = null, val integrationId: String? = null, val integrationMethod: String? = null, val integrationSubtype: String? = null, val integrationType: String? = null, val integrationUri: String? = null, val passthroughBehavior: String? = null, val payloadFormatVersion: String? = null, val requestParameters: Map<String, String>? = null, val requestTemplates: Map<String, String>? = null, val responseParameters: Map<String, IntegrationResponseParameterMap>? = null, val templateSelectionExpression: String? = null, val timeoutInMillis: Int? = null, val tlsConfig: IntegrationTlsConfig? = null)

GetModelResult

data class GetModelResult(val contentType: String? = null, val description: String? = null, val modelId: String? = null, val name: String? = null, val schema: Any? = null)

GetRouteResponseResult

data class GetRouteResponseResult(val modelSelectionExpression: String? = null, val responseModels: Any? = null, val responseParameters: Map<String, RouteResponseParameterConstraints>? = null, val routeResponseId: String? = null, val routeResponseKey: String? = null)

GetRouteResult

data class GetRouteResult(val apiKeyRequired: Boolean? = null, val authorizationScopes: List<String>? = null, val authorizationType: String? = null, val modelSelectionExpression: String? = null, val operationName: String? = null, val requestModels: Any? = null, val routeId: String? = null, val routeKey: String? = null, val routeResponseSelectionExpression: String? = null, val target: String? = null)

GetRoutingRuleResult

data class GetRoutingRuleResult(val actions: List<RoutingRuleAction>? = null, val conditions: List<RoutingRuleCondition>? = null, val priority: Int? = null, val routingRuleArn: String? = null, val routingRuleId: String? = null)

GetVpcLinkResult

data class GetVpcLinkResult(val name: String? = null, val tags: Map<String, String>? = null, val vpcLinkId: String? = null)

IntegrationResponseParameter

data class IntegrationResponseParameter(val destination: String? = null, val source: String? = null)

response parameter

IntegrationResponseParameterMap

data class IntegrationResponseParameterMap(val responseParameters: List<IntegrationResponseParameter>? = null)

map of response parameter lists

IntegrationTlsConfig

data class IntegrationTlsConfig(val serverNameToVerify: String? = null)

The TlsConfig property specifies the TLS configuration for a private integration. Supported only for HTTP APIs.

RouteParameterConstraints

data class RouteParameterConstraints(val required: Boolean)

RouteResponseParameterConstraints

data class RouteResponseParameterConstraints(val required: Boolean)

Specifies whether the parameter is required.

RoutingRuleAction

data class RoutingRuleAction(val invokeApi: RoutingRuleActionInvokeApi)

RoutingRuleActionInvokeApi

data class RoutingRuleActionInvokeApi(val apiId: String, val stage: String, val stripBasePath: Boolean? = null)

RoutingRuleCondition

data class RoutingRuleCondition(val matchBasePaths: RoutingRuleMatchBasePaths? = null, val matchHeaders: RoutingRuleMatchHeaders? = null)

RoutingRuleMatchBasePaths

data class RoutingRuleMatchBasePaths(val anyOf: List<String>)

RoutingRuleMatchHeaders

data class RoutingRuleMatchHeaders(val anyOf: List<RoutingRuleMatchHeaderValue>)

RoutingRuleMatchHeaderValue

data class RoutingRuleMatchHeaderValue(val header: String, val valueGlob: String)